Used to internationalize outgoing emails (e.g. for email verification, recovery, etc.).
If email delivery by Hanko is enabled the values for supported languages are:
"bn" (Bengali/Bangla)
"de" (German)
"en" (English)
"fr" (French)
"it" (Italian)
"nl" (Dutch)
"pt-BR" (Brazilian Portuguese),
"zh" (Chinese)
If email delivery by Hanko is disabled and a webhook has been configured for the email.send event, the
JWT payload of the token contained in the response to the webhook endpoint contains a language claim that
reflects the value originally passed as the header value.
String of the format {action_name}@{flow_id}. Indicates the action to perform on the flow with the
given flow_id. Omitting the query parameter initializes a new flow.
Note for playground usage: You can derive the value for this query parameter from the action's href
property in a flow state response, e.g. for an href value of
/login?action=register_client_capabilities%4015655672-41ca-48cc-afb1-90be77075764 the (non-URL-encoded) value
would be register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764.
Not required on flow initialization, i.e. on requests without an action
query parameter.
Required on all other requests performing an action, i.e. on requests that use an action
query parameter. Should be the csrf_token value from the most recent flow state response.
List of actions that can be performed in the current flow state in order to advance the flow to the next
state.
Depending on user details (e.g. presence or absence of credentials) or the tenant's configuration
some actions may or may not be present in the response.
Additional data that can be used by the client (e.g. user or sessions data provided in the
profile flow) or should/must be used as intermediary data in an out of band process to produce input data
for advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the
Webauthn API to produce an assertion/attestation).
{"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":"6ae130142e7b9f2a4eb1451d","collectionId":"e51a69b0-9d1a-4cbb-828c-c20cc6c4b68c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae130142e7b9f2a4eb1451d"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae130142e7b9f2a4eb1451d","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Hanko Docs","count":127},{"language":"default","tag":"Resources","count":68},{"language":"default","tag":"API reference","count":64},{"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"billing-updated-9-15","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":"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},{"name":"turbopuffer-dual-write","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":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/flow/profile","slug":"/api-reference/flow/profile","pageMetadata":{"openapi":"post /profile","title":"Profile","description":"Initialize or advance a profile flow.","href":"/api-reference/flow/profile"},"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: \"Initialize or advance a profile flow.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=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":"post /profile","title":"Profile","description":"Initialize or advance a profile flow.","href":"/api-reference/flow/profile"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["flow"],"description":"Initialize or advance a profile flow.","summary":"Profile","security":["82c1c49a-3e08-4046-b26a-202b56d36371","2a0eb107-21aa-4beb-968f-487cb4113bb9"],"parameters":["e7cf3d53-8333-4474-95ff-a3ce2273b11e","7be944d4-356b-4a2e-868e-d19f254699f2"],"requestBody":"b1d29d04-75c0-4c85-8d11-38911c9c2f83","responses":{"200":"ee60ccde-f8de-41d9-8239-908d724b785f","400":"c3225bab-6328-44f1-8751-59f132b56828","401":"1c6461c0-062a-45a6-bd84-5375757e295e","403":"6b806e58-fbcc-4926-b783-429f0da439e7","404":"7f83d7c5-a7a4-4069-80a5-2ac536067dab","410":"ec7f4afc-3630-4f0a-a04e-ce535fabc046","429":"80af2ca7-0119-46f8-bfaf-cd6d862dffc6","500":"f030bdb3-89ec-461f-b332-62f13d5a544f"},"method":"post","type":"path","servers":["13180741-3fb2-490c-8642-e04385305008"],"path":"/profile","baseUrlOptions":["https://{tenant_id}.hanko.io"],"title":"Profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e7cf3d53-8333-4474-95ff-a3ce2273b11e":{"in":"query","name":"action","description":"String of the format `{action_name}@{flow_id}`. Indicates the action to perform on the flow with the \ngiven `flow_id`. Omitting the query parameter initializes a new flow.\n\n_Note for playground usage_: You can derive the value for this query parameter from the `action`'s `href` \nproperty in a flow state response, e.g. for an `href` value of \n`/login?action=register_client_capabilities%4015655672-41ca-48cc-afb1-90be77075764` the (non-URL-encoded) value\nwould be `register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764`.\n","schema":{"type":"string","example":"register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764","description":"String of the format `{action_name}@{flow_id}`. Indicates the action to perform on the flow with the \ngiven `flow_id`. Omitting the query parameter initializes a new flow.\n\n_Note for playground usage_: You can derive the value for this query parameter from the `action`'s `href` \nproperty in a flow state response, e.g. for an `href` value of \n`/login?action=register_client_capabilities%4015655672-41ca-48cc-afb1-90be77075764` the (non-URL-encoded) value\nwould be `register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764`.\n","uniqueKey":"","typeLabel":"string"}},"7be944d4-356b-4a2e-868e-d19f254699f2":{"in":"header","name":"X-Language","schema":{"type":"string","enum":["bn","de","en","fr","it","nl","pt-BR","zh"],"description":"Used to internationalize outgoing emails (e.g. for email verification, recovery, etc.). \n\nIf email delivery by Hanko is enabled the values for supported languages are: \n - \"bn\" (Bengali/Bangla)\n - \"de\" (German) \n - \"en\" (English) \n - \"fr\" (French) \n - \"it\" (Italian) \n - \"nl\" (Dutch)\n - \"pt-BR\" (Brazilian Portuguese), \n - \"zh\" (Chinese)\n\nIf email delivery by Hanko is disabled and a webhook has been configured for the `email.send` event, the\nJWT payload of the `token` contained in the response to the webhook endpoint contains a `language` claim that\nreflects the value originally passed as the header value.\n","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Used to internationalize outgoing emails (e.g. for email verification, recovery, etc.). \n\nIf email delivery by Hanko is enabled the values for supported languages are: \n - \"bn\" (Bengali/Bangla)\n - \"de\" (German) \n - \"en\" (English) \n - \"fr\" (French) \n - \"it\" (Italian) \n - \"nl\" (Dutch)\n - \"pt-BR\" (Brazilian Portuguese), \n - \"zh\" (Chinese)\n\nIf email delivery by Hanko is disabled and a webhook has been configured for the `email.send` event, the\nJWT payload of the `token` contained in the response to the webhook endpoint contains a `language` claim that\nreflects the value originally passed as the header value.\n"}},"requestBody":{"description":"ProfileRequestBody","content":{"application/json":{"schema":{"title":"Profile request body","type":"object","properties":{"input_data":{"oneOf":[{"type":"object","title":"RegisterClientCapabilities","description":"Input data for the `register_client_capabilities` action.","required":["webauthn_available"],"properties":{"webauthn_available":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"input_data.oneOf.0.webauthn_available","typeLabel":"boolean"},"webauthn_conditional_mediation_available":{"type":"boolean","default":false,"uniqueKey":"input_data.oneOf.0.webauthn_conditional_mediation_available","typeLabel":"boolean"},"webauthn_platform_authenticator_available":{"type":"boolean","default":false,"uniqueKey":"input_data.oneOf.0.webauthn_platform_authenticator_available","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.0","typeLabel":"RegisterClientCapabilities · object"},{"type":"object","title":"ConnectThirdPartyOAuthProvider","description":"Input data for the `connect_thirdparty_oauth_provider` action.","required":["provider","redirect_to"],"properties":{"provider":{"type":"string","description":"The third-party OAuth provider to connect.","isRequired":true,"uniqueKey":"input_data.oneOf.1.provider","typeLabel":"string"},"redirect_to":{"type":"string","description":"URL to redirect to after authentication with the provider.","isRequired":true,"uniqueKey":"input_data.oneOf.1.redirect_to","typeLabel":"string"},"code_verifier":{"type":"string","description":"The code verifier for a PKCE OAuth flow.","uniqueKey":"input_data.oneOf.1.code_verifier","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.1","typeLabel":"ConnectThirdPartyOAuthProvider · object"},{"type":"object","title":"DisconnectThirdPartyOAuthProvider","description":"Input data for the `disconnect_thirdparty_oauth_provider` action.","required":["identity_id"],"properties":{"identity_id":{"type":"string","format":"uuid4","description":"The ID of the third party identity to remove.","isRequired":true,"uniqueKey":"input_data.oneOf.2.identity_id","typeLabel":"string\u003cuuid4>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.2","typeLabel":"DisconnectThirdPartyOAuthProvider · object"},{"type":"object","title":"EmailCreate","description":"Input data for the `email_create` action.","required":["emai"],"properties":{"email":{"type":"string","format":"email","uniqueKey":"input_data.oneOf.3.email","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.3","typeLabel":"EmailCreate · object"},{"type":"object","title":"EmailDelete","description":"Input data for the `email_delete` action.","required":["email_id"],"properties":{"email_id":{"type":"string","format":"email","isRequired":true,"uniqueKey":"input_data.oneOf.4.email_id","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.4","typeLabel":"EmailDelete · object"},{"type":"object","title":"EmailSetPrimary","description":"Input data for the `email_set_primary` action.","required":["email_id"],"properties":{"email_id":{"type":"string","format":"email","isRequired":true,"uniqueKey":"input_data.oneOf.5.email_id","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.5","typeLabel":"EmailSetPrimary · object"},{"type":"object","title":"EmailVerify","description":"Input data for the `email_verify` action.","required":["email_id"],"properties":{"email_id":{"type":"string","format":"email","isRequired":true,"uniqueKey":"input_data.oneOf.6.email_id","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.6","typeLabel":"EmailVerify · object"},{"type":"object","title":"ExchangeToken","description":"Input data for the `exchange_token` action.","required":["token"],"properties":{"token":{"type":"string","isRequired":true,"uniqueKey":"input_data.oneOf.7.token","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.7","typeLabel":"ExchangeToken · object"},{"type":"object","title":"PasswordCreate","description":"Input data for the `password_create` action.","required":["email_id"],"properties":{"password":{"type":"string","format":"email","uniqueKey":"input_data.oneOf.8.password","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.8","typeLabel":"PasswordCreate · object"},{"type":"object","title":"PasswordUpdate","description":"Input data for the `password_update` action.","required":["email_id"],"properties":{"password":{"type":"string","format":"email","uniqueKey":"input_data.oneOf.9.password","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.9","typeLabel":"PasswordUpdate · object"},{"type":"object","title":"PatchMetadata","description":"Input data for the `patch_metadata` action.","required":["patch_metadata"],"properties":{"patch_metadata":{"type":"object","description":"Must be one of:\n - `null`: unsets the entire (unsafe) metadata \n - an empty object `{}`: indicates an empty patch object, results in a noop\n - a non-empty object: the current (unsafe) metadata is merged with this patch\n","additionalProperties":true,"isRequired":true,"uniqueKey":"input_data.oneOf.10.patch_metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.10","typeLabel":"PatchMetadata · object"},{"type":"object","title":"OTPCodeVerify","description":"Input data for the `otp_code_verify` action.","required":["otp_code"],"properties":{"otp_code":{"description":"","type":"string","minLength":6,"maxLength":6,"isRequired":true,"uniqueKey":"input_data.oneOf.11.otp_code","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.11","typeLabel":"OTPCodeVerify · object"},{"type":"object","title":"SecurityKeyDelete","description":"Input data for the `security_key_delete` action.","required":["security_key_id"],"properties":{"security_key_id":{"type":"string","isRequired":true,"uniqueKey":"input_data.oneOf.12.security_key_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.12","typeLabel":"SecurityKeyDelete · object"},{"type":"object","title":"SessionDelete","description":"Input data for the `session_delete` action.","required":["session_id"],"properties":{"session_id":{"description":"The ID of the session to revoke. \n\nIf server-side sessions are enabled, session IDs can be obtained from\nsession tokens (JWTs) through their `session_id` claim.\n","type":"string","format":"uuid4","isRequired":true,"uniqueKey":"input_data.oneOf.13.session_id","typeLabel":"string\u003cuuid4>"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.13","typeLabel":"SessionDelete · object"},{"type":"object","title":"UsernameSet","description":"Input data for the `username_set` action.","required":["provider"],"properties":{"username":{"type":"string","uniqueKey":"input_data.oneOf.14.username","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.14","typeLabel":"UsernameSet · object"},{"type":"object","title":"VerifyPasscode","description":"Input data for the `verify_passcode` action.","required":["code"],"properties":{"code":{"type":"string","minLength":6,"maxLength":6,"isRequired":true,"uniqueKey":"input_data.oneOf.15.code","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.15","typeLabel":"VerifyPasscode · object"},{"type":"object","title":"WebauthnCredentialRename","description":"Input data for the `webauthn_credential_rename` action.","required":["passkey_id","passkey_name"],"properties":{"passkey_id":{"type":"string","isRequired":true,"uniqueKey":"input_data.oneOf.16.passkey_id","typeLabel":"string"},"passkey_name":{"type":"string","isRequired":true,"uniqueKey":"input_data.oneOf.16.passkey_name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.16","typeLabel":"WebauthnCredentialRename · object"},{"type":"object","title":"WebauthnVerifyAttestationResponse","description":"Input data for the `webauthn_verify_attestation_response` action.","required":["public_key"],"properties":{"public_key":{"description":"The [AuthenticatorAttestationResponse](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAttestationResponse)\nfrom the WebAuthn API.\n","type":"object","isRequired":true,"uniqueKey":"input_data.oneOf.17.public_key","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"input_data.oneOf.17","typeLabel":"WebauthnVerifyAttestationResponse · object"}],"uniqueKey":"input_data","typeLabel":"RegisterClientCapabilities · object | ConnectThirdPartyOAuthProvider · object | DisconnectThirdPartyOAuthProvider · object | EmailCreate · object | EmailDelete · object | EmailSetPrimary · object | EmailVerify · object | ExchangeToken · object | PasswordCreate · object | PasswordUpdate · object | PatchMetadata · object | OTPCodeVerify · object | SecurityKeyDelete · object | SessionDelete · object | UsernameSet · object | VerifyPasscode · object | WebauthnCredentialRename · object | WebauthnVerifyAttestationResponse · object"},"csrf_token":{"description":"Not required on flow initialization, i.e. on requests without an `action`\nquery parameter.\n\nRequired on all other requests performing an action, i.e. on requests that use an `action` \nquery parameter. Should be the `csrf_token` value from the most recent flow state response.\n","type":"string","example":"qvcZt29spXYO77Y9IaxxN4MzLnmbjozl","uniqueKey":"csrf_token","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"Profile request body · object"},"examples":{"Example":{"title":"Example","value":{"input_data":{"webauthn_available":false,"webauthn_conditional_mediation_available":false,"webauthn_platform_authenticator_available":false},"csrf_token":"qvcZt29spXYO77Y9IaxxN4MzLnmbjozl"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ee60ccde-f8de-41d9-8239-908d724b785f":{"description":"ProfileFlowResponse","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Preflight","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"register_client_capabilities":{"type":"object","description":"Provide information about whether the client is capable of using passkeys (a.k.a. the Webauthn API).","properties":{"action":{"type":"string","description":"The name of the action.","enum":["register_client_capabilities"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["webauthn_available"],"properties":{"webauthn_available":{"type":"object","description":"Indicates whether the client the device is capable of creating and using passkeys/WebAuthn credentials.\n","properties":{"name":{"type":"string","enum":["webauthn_available"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["boolean"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_available","typeLabel":"object"},"webauthn_conditional_mediation_available":{"type":"object","properties":{"name":{"type":"string","enum":["webauthn_conditional_mediation_available"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["boolean"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_conditional_mediation_available","typeLabel":"object"},"webauthn_platform_authenticator_available":{"type":"object","properties":{"name":{"type":"string","enum":["webauthn_platform_authenticator_available"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["boolean"],"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs.webauthn_platform_authenticator_available","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.register_client_capabilities","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["preflight"],"uniqueKey":"oneOf.0.name","typeLabel":"enum\u003cstring>"},"payload":{"description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","type":"object","uniqueKey":"oneOf.0.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.0.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.0.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.0.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.0","typeLabel":"Preflight · object"},{"type":"object","title":"ProfileInit","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"account_delete":{"type":"object","description":"Delete an account.\n","properties":{"action":{"type":"string","description":"The name of the action.","enum":["account_delete"],"uniqueKey":"oneOf.1.actions.account_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.account_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.account_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.account_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.account_delete","typeLabel":"object"},"connect_thirdparty_oauth_provider":{"type":"object","description":"Connect a third-party OAuth provider.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["connect_thirdparty_oauth_provider"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["provider","redirect_to"],"properties":{"provider":{"type":"object","properties":{"name":{"type":"string","enum":["provider"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"A display name to use for the provider.","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Can be any value - string, number, boolean, array or object.","enum":["apple","discord","facebook","github","google","linkedin","microsoft"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.provider","typeLabel":"object"},"redirect_to":{"type":"object","properties":{"name":{"type":"string","enum":["redirect_to"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.redirect_to","typeLabel":"object"},"code_verifier":{"type":"object","properties":{"name":{"type":"string","enum":["code_verifier"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs.code_verifier","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.connect_thirdparty_oauth_provider","typeLabel":"object"},"continue_to_otp_secret_creation":{"type":"object","description":"Continue to the `mfa_otp_secret_creation` state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["continue_to_otp_secret_creation"],"uniqueKey":"oneOf.1.actions.continue_to_otp_secret_creation.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.continue_to_otp_secret_creation.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.continue_to_otp_secret_creation.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.continue_to_otp_secret_creation.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.continue_to_otp_secret_creation","typeLabel":"object"},"disconnect_thirdparty_oauth_provider":{"type":"object","description":"Disconnect a third-party OAuth provider.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["disconnect_thirdparty_oauth_provider"],"uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"identity_id":{"type":"string","format":"uuid4","description":"The ID of the third party identity to remove.","uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider.inputs.identity_id","typeLabel":"string\u003cuuid4>"}},"uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.disconnect_thirdparty_oauth_provider","typeLabel":"object"},"email_create":{"type":"object","description":"Add an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_create"],"uniqueKey":"oneOf.1.actions.email_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.email_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.email_create.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email":{"type":"object","title":"Email","properties":{"name":{"type":"string","enum":["email"],"uniqueKey":"oneOf.1.actions.email_create.inputs.email.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["email"],"uniqueKey":"oneOf.1.actions.email_create.inputs.email.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_create.inputs.email.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_create.inputs.email.min_length","typeLabel":"integer"},"max_length":{"type":"integer","default":120,"uniqueKey":"oneOf.1.actions.email_create.inputs.email.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.email_create.inputs.email.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.email_create.inputs.email.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.email_create.inputs.email.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.email_create.inputs.email.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.email_create.inputs.email.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.email_create.inputs.email.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.email_create.inputs.email","typeLabel":"Email · object"}},"uniqueKey":"oneOf.1.actions.email_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_create","typeLabel":"object"},"email_delete":{"type":"object","description":"Delete an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_delete"],"uniqueKey":"oneOf.1.actions.email_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.email_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.email_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.email_delete.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_delete","typeLabel":"object"},"email_set_primary":{"type":"object","description":"Set an email as the primary email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_set_primary"],"uniqueKey":"oneOf.1.actions.email_set_primary.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.email_set_primary.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.email_set_primary.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.email_set_primary.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_set_primary.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_set_primary","typeLabel":"object"},"email_verify":{"type":"object","description":"Verify an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_verify"],"uniqueKey":"oneOf.1.actions.email_verify.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.email_verify.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.email_verify.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.email_verify.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_verify.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.email_verify","typeLabel":"object"},"otp_secret_delete":{"type":"object","description":"Delete an OTP secret.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["otp_secret_delete"],"uniqueKey":"oneOf.1.actions.otp_secret_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.otp_secret_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.otp_secret_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.otp_secret_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.otp_secret_delete","typeLabel":"object"},"password_create":{"type":"object","description":"Create a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_create"],"uniqueKey":"oneOf.1.actions.password_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.password_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.password_create.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"password":{"type":"object","properties":{"name":{"type":"string","enum":["password"],"uniqueKey":"oneOf.1.actions.password_create.inputs.password.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["password"],"uniqueKey":"oneOf.1.actions.password_create.inputs.password.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.password_create.inputs.password.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":8,"uniqueKey":"oneOf.1.actions.password_create.inputs.password.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.password_create.inputs.password.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.password_create.inputs.password.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.password_create.inputs.password.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.password_create.inputs.password.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.password_create.inputs.password.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.password_create.inputs.password.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.password_create.inputs.password.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.password_create.inputs.password","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.password_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.password_create","typeLabel":"object"},"password_update":{"type":"object","description":"Update a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_update"],"uniqueKey":"oneOf.1.actions.password_update.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.password_update.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.password_update.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"password":{"type":"object","properties":{"name":{"type":"string","enum":["password"],"uniqueKey":"oneOf.1.actions.password_update.inputs.password.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["password"],"uniqueKey":"oneOf.1.actions.password_update.inputs.password.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.password_update.inputs.password.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":8,"uniqueKey":"oneOf.1.actions.password_update.inputs.password.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.password_update.inputs.password.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.password_update.inputs.password.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.password_update.inputs.password.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.password_update.inputs.password.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.password_update.inputs.password.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.password_update.inputs.password.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.password_update.inputs.password.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.password_update.inputs.password","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.password_update.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.password_update","typeLabel":"object"},"password_delete":{"type":"object","description":"Delete a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_delete"],"uniqueKey":"oneOf.1.actions.password_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.password_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.password_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.password_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.password_delete","typeLabel":"object"},"patch_metadata":{"type":"object","description":"Patches the (unsafe) metadata of a user.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["patch_metadata"],"uniqueKey":"oneOf.1.actions.patch_metadata.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.patch_metadata.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.patch_metadata.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"patch_metadata":{"type":"object","properties":{"name":{"type":"string","enum":["patch_metadata"],"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["json"],"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.patch_metadata.inputs.patch_metadata","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.patch_metadata.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.patch_metadata","typeLabel":"object"},"security_key_create":{"type":"object","description":"Create a security key.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["security_key_create"],"uniqueKey":"oneOf.1.actions.security_key_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.security_key_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.security_key_create.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.security_key_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.security_key_create","typeLabel":"object"},"security_key_delete":{"type":"object","description":"Delete a security key.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["security_key_delete"],"uniqueKey":"oneOf.1.actions.security_key_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.security_key_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.security_key_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"security_key_id":{"type":"object","properties":{"name":{"type":"string","enum":["security_key_id"],"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.security_key_delete.inputs.security_key_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.security_key_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.security_key_delete","typeLabel":"object"},"session_delete":{"type":"object","description":"Revoke a session.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["session_delete"],"uniqueKey":"oneOf.1.actions.session_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.session_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.session_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"session_id":{"type":"object","properties":{"name":{"type":"string","enum":["session_id"],"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.actions.session_delete.inputs.session_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.session_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.session_delete","typeLabel":"object"},"username_set":{"type":"object","description":"Set a username.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["username_set"],"uniqueKey":"oneOf.1.actions.username_set.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.username_set.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.username_set.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["username"],"properties":{"username":{"type":"object","title":"Username","properties":{"name":{"type":"string","enum":["username"],"uniqueKey":"oneOf.1.actions.username_set.inputs.username.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.username_set.inputs.username.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.username_set.inputs.username.required","typeLabel":"boolean"},"min_length":{"type":"integer","enum":[3],"uniqueKey":"oneOf.1.actions.username_set.inputs.username.min_length","typeLabel":"enum\u003cinteger>"},"max_length":{"type":"integer","enum":[40],"uniqueKey":"oneOf.1.actions.username_set.inputs.username.max_length","typeLabel":"enum\u003cinteger>"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.username_set.inputs.username.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.username_set.inputs.username.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.username_set.inputs.username.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.username_set.inputs.username.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.username_set.inputs.username.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.username_set.inputs.username.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.username_set.inputs.username","typeLabel":"Username · object"}},"uniqueKey":"oneOf.1.actions.username_set.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.username_set","typeLabel":"object"},"username_delete":{"type":"object","description":"Delete a username.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["username_create"],"uniqueKey":"oneOf.1.actions.username_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.username_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.username_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.username_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.username_delete","typeLabel":"object"},"webauthn_credential_rename":{"type":"object","description":"Rename a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_rename"],"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["passkey_id","passkey_name"],"properties":{"passkey_id":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_id"],"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_id","typeLabel":"object"},"passkey_name":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_name"],"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs.passkey_name","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_rename","typeLabel":"object"},"webauthn_credential_create":{"type":"object","description":"Generate passkey creation options for registering a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_create"],"uniqueKey":"oneOf.1.actions.webauthn_credential_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_create.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.webauthn_credential_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_create","typeLabel":"object"},"webauthn_credential_delete":{"type":"object","description":"Delete a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_delete"],"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["passkey_id"],"properties":{"passkey_id":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_id"],"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs.passkey_id","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.webauthn_credential_delete","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["profile_init"],"uniqueKey":"oneOf.1.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","properties":{"user":{"description":"Data pertaining to the user associated with the current session.","type":"object","properties":{"user_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.user_id","typeLabel":"string\u003cuuid>"},"passkeys":{"type":"array","items":{"type":"object","properties":{"aaguid":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].aaguid","typeLabel":"string\u003cuuid>"},"attestation_type":{"type":"string","enum":["none","packed","tpm","android-key","android-safetynet","fido-u2f","apple"],"uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].attestation_type","typeLabel":"enum\u003cstring>"},"backup_eligible":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].backup_eligible","typeLabel":"boolean"},"backup_state":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].backup_state","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"last_used_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"},"mfa_only":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].mfa_only","typeLabel":"boolean"},"public-key":{"type":"string","uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].public-key","typeLabel":"string"},"transports":{"type":"array","items":{"type":"string","enum":["ble","internal","nfc","usb"],"uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].transports.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX].transports","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"oneOf.1.payload.user.passkeys.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.user.passkeys","typeLabel":"object[]"},"security_keys":{"type":"array","items":{"type":"object","properties":{"aaguid":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].aaguid","typeLabel":"string\u003cuuid>"},"attestation_type":{"type":"string","enum":["none","packed","tpm","android-key","android-safetynet","fido-u2f","apple"],"uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].attestation_type","typeLabel":"enum\u003cstring>"},"backup_eligible":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].backup_eligible","typeLabel":"boolean"},"backup_state":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].backup_state","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"last_used_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"},"mfa_only":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].mfa_only","typeLabel":"boolean"},"public-key":{"type":"string","uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].public-key","typeLabel":"string"},"transports":{"type":"array","items":{"type":"string","enum":["ble","internal","nfc","usb"],"uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].transports.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX].transports","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"oneOf.1.payload.user.security_keys.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.user.security_keys","typeLabel":"object[]"},"emails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"address":{"type":"string","format":"email","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].address","typeLabel":"string\u003cemail>"},"is_primary":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].is_primary","typeLabel":"boolean"},"is_verified":{"type":"boolean","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].is_verified","typeLabel":"boolean"},"identity":{"deprecated":true,"description":"Deprecated. See `identities` instead.","type":"object","properties":{"id":{"type":"string","description":"Contains the ID of the user at the provider.","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identity.id","typeLabel":"string"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identity.provider","typeLabel":"string"}},"uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identity","typeLabel":"object"},"identities":{"deprecated":true,"description":"Deprecated. See top-level `identities` instead.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user at the provider","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identities.items.[INDEX].id","typeLabel":"string"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identities.items.[INDEX].provider","typeLabel":"string"}},"uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX].identities","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.payload.user.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.user.emails","typeLabel":"object[]"},"identities":{"description":"The user's third party connections/identities.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the user at the provider","uniqueKey":"oneOf.1.payload.user.identities.items.[INDEX].id","typeLabel":"string"},"identity_id":{"type":"string","description":"The identity's ID","format":"uuid4","uniqueKey":"oneOf.1.payload.user.identities.items.[INDEX].identity_id","typeLabel":"string\u003cuuid4>"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.1.payload.user.identities.items.[INDEX].provider","typeLabel":"string"}},"uniqueKey":"oneOf.1.payload.user.identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.user.identities","typeLabel":"object[]"},"metadata":{"type":"object","properties":{"public_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.payload.user.metadata.public_metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1.payload.user.metadata.public_metadata","typeLabel":"object"},"unsafe_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.payload.user.metadata.unsafe_metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1.payload.user.metadata.unsafe_metadata","typeLabel":"object"}},"uniqueKey":"oneOf.1.payload.user.metadata","typeLabel":"object"},"mfa_config":{"type":"object","properties":{"auth_app_set_up":{"type":"boolean","description":"Indicates whether the user has set up an authenticator app for 2FA.","uniqueKey":"oneOf.1.payload.user.mfa_config.auth_app_set_up","typeLabel":"boolean"},"totp_enabled":{"type":"boolean","description":"Indicates whether 2FA via authenticator app is enabled on this tenant. \n\nTo check whether a user has set up an authenticator app for 2FA, see `payload.user.mfa_config.auth_app_set_up`.\n","uniqueKey":"oneOf.1.payload.user.mfa_config.totp_enabled","typeLabel":"boolean"},"security_keys_enabled":{"type":"boolean","description":"Indicates whether 2FA via security keys is enabled on this tenant.\n\nTo check whether a user has enrolled security keys for 2FA, see `payload.user.security_keys`.\n","uniqueKey":"oneOf.1.payload.user.mfa_config.security_keys_enabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.payload.user.mfa_config","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.user.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","uniqueKey":"oneOf.1.payload.user.name","typeLabel":"string"},"given_name":{"type":"string","uniqueKey":"oneOf.1.payload.user.given_name","typeLabel":"string"},"family_name":{"type":"string","uniqueKey":"oneOf.1.payload.user.family_name","typeLabel":"string"},"picture":{"type":"string","format":"uri","uniqueKey":"oneOf.1.payload.user.picture","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.1.payload.user","typeLabel":"object"},"sessions":{"description":"List of active sessions for this user.","type":"array","items":{"type":"object","properties":{"created_at":{"description":"Time of creation of the session.","type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"current":{"description":"Indicates whether this session is the session currently used.","type":"boolean","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].current","typeLabel":"boolean"},"expires_at":{"description":"Time of expiry of the session.","type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"The ID of the session.","type":"string","format":"uuid","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"ip_address":{"oneOf":[{"type":"string","description":"IPv4 address the session was initialized from.","format":"ipv4","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].ip_address.oneOf.0","typeLabel":"string\u003cipv4>"},{"type":"string","description":"IPv6 address the session was initialized from.","format":"ipv6","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].ip_address.oneOf.1","typeLabel":"string\u003cipv6>"}],"uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].ip_address","typeLabel":"string\u003cipv4> | string\u003cipv6>"},"last_used":{"description":"Time of last usage of this session.","type":"string","format":"date-time","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].last_used","typeLabel":"string\u003cdate-time>"},"user_agent":{"description":"User agent string consisting of the native platform that the browser is running on (Windows, Mac, \nLinux, Android, etc.) and a parenthesised name of the user agent.\n","type":"string","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].user_agent","typeLabel":"string"},"user_agent_raw":{"description":"The complete user agent, i.e. the exact value of the `User-Agent` header the API received\nin the request(s) for establishing the session.\n","type":"string","uniqueKey":"oneOf.1.payload.sessions.items.[INDEX].user_agent_raw","typeLabel":"string"}},"uniqueKey":"oneOf.1.payload.sessions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.payload.sessions","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.1.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.1.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.1.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.1","typeLabel":"ProfileInit · object"},{"type":"object","title":"ProfileAccountDeleted","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","uniqueKey":"oneOf.2.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["account_deleted"],"uniqueKey":"oneOf.2.name","typeLabel":"enum\u003cstring>"},"payload":{"description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","type":"object","uniqueKey":"oneOf.2.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.2.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.2.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.2.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.2","typeLabel":"ProfileAccountDeleted · object"},{"type":"object","title":"PasscodeConfirmation","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"verify_passcode":{"type":"object","description":"Verify a passcode.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["verify_passcode"],"uniqueKey":"oneOf.3.actions.verify_passcode.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.3.actions.verify_passcode.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.3.actions.verify_passcode.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["code"],"properties":{"code":{"type":"object","properties":{"name":{"type":"string","enum":["code"],"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":6,"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.min_length","typeLabel":"integer"},"max_length":{"type":"integer","default":6,"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.3.actions.verify_passcode.inputs.code","typeLabel":"object"}},"uniqueKey":"oneOf.3.actions.verify_passcode.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.3.actions.verify_passcode","typeLabel":"object"},"resend_passcode":{"type":"object","description":"Resend a passcode.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["resend_passcode"],"uniqueKey":"oneOf.3.actions.resend_passcode.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.3.actions.resend_passcode.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.3.actions.resend_passcode.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.3.actions.resend_passcode.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.3.actions.resend_passcode","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.3.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.3.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.3.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.3.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.3.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.3.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["passcode_confirmation"],"uniqueKey":"oneOf.3.name","typeLabel":"enum\u003cstring>"},"payload":{"description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","type":"object","uniqueKey":"oneOf.3.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.3.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.3.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.3.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.3.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.3.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.3.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.3.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.3.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.3","typeLabel":"PasscodeConfirmation · object"},{"type":"object","title":"ProfileWebauthnCredentialVerification","properties":{"actions":{"type":"object","description":"ActionsWebauthnVerifyAttestationResponse","properties":{"webauthn_verify_attestation_response":{"type":"object","description":"Verify an attestation response to complete a passkey registration.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_verify_attestation_response"],"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["public_key"],"properties":{"public_key":{"type":"object","properties":{"name":{"type":"string","enum":["public-key"],"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["json"],"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs.public_key","typeLabel":"object"}},"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.4.actions.webauthn_verify_attestation_response","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.4.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.4.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.4.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.4.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.4.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.4.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["webauthn_credential_verification"],"uniqueKey":"oneOf.4.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","required":["creation_options"],"properties":{"creation_options":{"description":"Options for credential creation with the WebAuthn API","externalDocs":{"url":"https://www.w3.org/TR/webauthn-2/#dictionary-makecredentialoptions"},"type":"object","properties":{"publicKey":{"type":"object","properties":{"rp":{"type":"object","properties":{"name":{"type":"string","example":"Hanko Authentication Service","uniqueKey":"oneOf.4.payload.creation_options.publicKey.rp.name","typeLabel":"string"},"id":{"type":"string","example":"localhost","uniqueKey":"oneOf.4.payload.creation_options.publicKey.rp.id","typeLabel":"string"}},"uniqueKey":"oneOf.4.payload.creation_options.publicKey.rp","typeLabel":"object"},"user":{"type":"object","properties":{"id":{"type":"string","example":"pPQT9rwJRD7gVncsnCDNyN","uniqueKey":"oneOf.4.payload.creation_options.publicKey.user.id","typeLabel":"string"},"name":{"type":"string","example":"user@example.com","uniqueKey":"oneOf.4.payload.creation_options.publicKey.user.name","typeLabel":"string"},"displayName":{"type":"string","example":"user@example.com","uniqueKey":"oneOf.4.payload.creation_options.publicKey.user.displayName","typeLabel":"string"}},"uniqueKey":"oneOf.4.payload.creation_options.publicKey.user","typeLabel":"object"},"challenge":{"type":"string","format":"base64url","example":"7qmkJUXR0dOFnsW48evX3qKdCzlGjvvqAAvMDN+KTN0=","uniqueKey":"oneOf.4.payload.creation_options.publicKey.challenge","typeLabel":"string\u003cbase64url>"},"pubKeyCredParams":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["public-key"],"uniqueKey":"oneOf.4.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"alg":{"type":"number","uniqueKey":"oneOf.4.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX].alg","typeLabel":"number"}},"uniqueKey":"oneOf.4.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX]","typeLabel":"object"},"example":[{"type":"public-key","alg":-7}],"uniqueKey":"oneOf.4.payload.creation_options.publicKey.pubKeyCredParams","typeLabel":"object[]"},"timeout":{"type":"number","format":"int64","example":60000,"uniqueKey":"oneOf.4.payload.creation_options.publicKey.timeout","typeLabel":"number\u003cint64>"},"authenticatorSelection":{"type":"object","properties":{"authenticatorAttachment":{"type":"string","enum":["platform","cross-platform"],"example":"platform","uniqueKey":"oneOf.4.payload.creation_options.publicKey.authenticatorSelection.authenticatorAttachment","typeLabel":"enum\u003cstring>"},"requireResidentKey":{"type":"boolean","example":true,"uniqueKey":"oneOf.4.payload.creation_options.publicKey.authenticatorSelection.requireResidentKey","typeLabel":"boolean"},"residentKey":{"type":"string","enum":["discouraged","preferred","required"],"example":"preferred","uniqueKey":"oneOf.4.payload.creation_options.publicKey.authenticatorSelection.residentKey","typeLabel":"enum\u003cstring>"},"userVerification":{"type":"string","enum":["discouraged","preferred","required"],"example":"required","uniqueKey":"oneOf.4.payload.creation_options.publicKey.authenticatorSelection.userVerification","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.payload.creation_options.publicKey.authenticatorSelection","typeLabel":"object"},"attestation":{"type":"string","enum":["none","indirect","direct","enterprise"],"example":"none","uniqueKey":"oneOf.4.payload.creation_options.publicKey.attestation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.payload.creation_options.publicKey","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.4.payload.creation_options","typeLabel":"object"}},"uniqueKey":"oneOf.4.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.4.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.4.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.4.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.4.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.4.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.4.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.4.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.4.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.4","typeLabel":"ProfileWebauthnCredentialVerification · object"},{"type":"object","title":"MFAOTPSecretCreation","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"otp_code_verify":{"type":"object","description":"Verify an OTP code to set up (T)OTP MFA.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["otp_code_verify"],"uniqueKey":"oneOf.5.actions.otp_code_verify.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.5.actions.otp_code_verify.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.5.actions.otp_code_verify.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["otp_code"],"properties":{"otp_code":{"type":"object","properties":{"name":{"type":"string","enum":["otp_code"],"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs.otp_code","typeLabel":"object"}},"uniqueKey":"oneOf.5.actions.otp_code_verify.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.5.actions.otp_code_verify","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.5.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.5.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.5.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.5.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.5.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.5.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["mfa_otp_secret_creation"],"uniqueKey":"oneOf.5.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","properties":{"otp_image_source":{"description":"Contains a QR code to scan with an authenticator app as a string in \n[\"data\" URL](https://datatracker.ietf.org/doc/html/rfc2397) format. Can be directly\nused as the value for the `src` attribute in an HTML `img` element.\n","type":"string","uniqueKey":"oneOf.5.payload.otp_image_source","typeLabel":"string"},"otp_secret":{"description":"Shared secret that can be provided to authenticator apps if scanning\na QR code is not available.\n","type":"string","uniqueKey":"oneOf.5.payload.otp_secret","typeLabel":"string"}},"uniqueKey":"oneOf.5.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.5.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.5.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.5.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.5.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.5.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.5.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.5.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.5.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.5.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.5","typeLabel":"MFAOTPSecretCreation · object"},{"type":"object","title":"ThirdParty","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"exchange_token":{"type":"object","description":"Exchange a one time token after a third party authentication for a session token.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["exchange_token"],"uniqueKey":"oneOf.6.actions.exchange_token.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.6.actions.exchange_token.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.6.actions.exchange_token.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"token":{"type":"object","properties":{"name":{"type":"string","enum":["token"],"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.6.actions.exchange_token.inputs.token","typeLabel":"object"}},"uniqueKey":"oneOf.6.actions.exchange_token.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.6.actions.exchange_token","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.6.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.6.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.6.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.6.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.6.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.6.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["thirdparty"],"uniqueKey":"oneOf.6.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","required":["redirect_url"],"properties":{"redirect_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"oneOf.6.payload.redirect_url","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.6.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[200],"uniqueKey":"oneOf.6.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.6.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.6.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.6.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.6.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.6.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.6.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.6.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.6.links","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.6","typeLabel":"ThirdParty · object"}],"uniqueKey":"","typeLabel":"Preflight · object | ProfileInit · object | ProfileAccountDeleted · object | PasscodeConfirmation · object | ProfileWebauthnCredentialVerification · object | MFAOTPSecretCreation · object | ThirdParty · object"},"examples":{"Example":{"title":"Example","value":{"actions":{"register_client_capabilities":{"action":"register_client_capabilities","href":"\u003cstring>","description":"\u003cstring>","inputs":{"webauthn_available":{"name":"webauthn_available","type":"boolean","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]},"webauthn_conditional_mediation_available":{"name":"webauthn_conditional_mediation_available","type":"boolean","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]},"webauthn_platform_authenticator_available":{"name":"webauthn_platform_authenticator_available","type":"boolean","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}}},"name":"preflight","payload":{},"status":200,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"c3225bab-6328-44f1-8751-59f132b56828":{"description":"ProfileFlowResponseBadRequestError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ProfileInit","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"account_delete":{"type":"object","description":"Delete an account.\n","properties":{"action":{"type":"string","description":"The name of the action.","enum":["account_delete"],"uniqueKey":"oneOf.0.actions.account_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.account_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.account_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.account_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.account_delete","typeLabel":"object"},"connect_thirdparty_oauth_provider":{"type":"object","description":"Connect a third-party OAuth provider.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["connect_thirdparty_oauth_provider"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["provider","redirect_to"],"properties":{"provider":{"type":"object","properties":{"name":{"type":"string","enum":["provider"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"A display name to use for the provider.","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Can be any value - string, number, boolean, array or object.","enum":["apple","discord","facebook","github","google","linkedin","microsoft"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.provider","typeLabel":"object"},"redirect_to":{"type":"object","properties":{"name":{"type":"string","enum":["redirect_to"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.redirect_to","typeLabel":"object"},"code_verifier":{"type":"object","properties":{"name":{"type":"string","enum":["code_verifier"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs.code_verifier","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.connect_thirdparty_oauth_provider","typeLabel":"object"},"continue_to_otp_secret_creation":{"type":"object","description":"Continue to the `mfa_otp_secret_creation` state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["continue_to_otp_secret_creation"],"uniqueKey":"oneOf.0.actions.continue_to_otp_secret_creation.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.continue_to_otp_secret_creation.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.continue_to_otp_secret_creation.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.continue_to_otp_secret_creation.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.continue_to_otp_secret_creation","typeLabel":"object"},"disconnect_thirdparty_oauth_provider":{"type":"object","description":"Disconnect a third-party OAuth provider.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["disconnect_thirdparty_oauth_provider"],"uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"identity_id":{"type":"string","format":"uuid4","description":"The ID of the third party identity to remove.","uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider.inputs.identity_id","typeLabel":"string\u003cuuid4>"}},"uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.disconnect_thirdparty_oauth_provider","typeLabel":"object"},"email_create":{"type":"object","description":"Add an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_create"],"uniqueKey":"oneOf.0.actions.email_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.email_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.email_create.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email":{"type":"object","title":"Email","properties":{"name":{"type":"string","enum":["email"],"uniqueKey":"oneOf.0.actions.email_create.inputs.email.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["email"],"uniqueKey":"oneOf.0.actions.email_create.inputs.email.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_create.inputs.email.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_create.inputs.email.min_length","typeLabel":"integer"},"max_length":{"type":"integer","default":120,"uniqueKey":"oneOf.0.actions.email_create.inputs.email.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.email_create.inputs.email.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.email_create.inputs.email.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.email_create.inputs.email.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.email_create.inputs.email.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.email_create.inputs.email.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.email_create.inputs.email.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.email_create.inputs.email","typeLabel":"Email · object"}},"uniqueKey":"oneOf.0.actions.email_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_create","typeLabel":"object"},"email_delete":{"type":"object","description":"Delete an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_delete"],"uniqueKey":"oneOf.0.actions.email_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.email_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.email_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.email_delete.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_delete","typeLabel":"object"},"email_set_primary":{"type":"object","description":"Set an email as the primary email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_set_primary"],"uniqueKey":"oneOf.0.actions.email_set_primary.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.email_set_primary.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.email_set_primary.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.email_set_primary.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_set_primary.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_set_primary","typeLabel":"object"},"email_verify":{"type":"object","description":"Verify an email.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["email_verify"],"uniqueKey":"oneOf.0.actions.email_verify.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.email_verify.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.email_verify.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"email_id":{"type":"object","properties":{"name":{"type":"string","enum":["email_id"],"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.email_verify.inputs.email_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_verify.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.email_verify","typeLabel":"object"},"otp_secret_delete":{"type":"object","description":"Delete an OTP secret.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["otp_secret_delete"],"uniqueKey":"oneOf.0.actions.otp_secret_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.otp_secret_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.otp_secret_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.otp_secret_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.otp_secret_delete","typeLabel":"object"},"password_create":{"type":"object","description":"Create a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_create"],"uniqueKey":"oneOf.0.actions.password_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.password_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.password_create.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"password":{"type":"object","properties":{"name":{"type":"string","enum":["password"],"uniqueKey":"oneOf.0.actions.password_create.inputs.password.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["password"],"uniqueKey":"oneOf.0.actions.password_create.inputs.password.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.password_create.inputs.password.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":8,"uniqueKey":"oneOf.0.actions.password_create.inputs.password.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.password_create.inputs.password.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.password_create.inputs.password.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.password_create.inputs.password.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.password_create.inputs.password.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.password_create.inputs.password.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.password_create.inputs.password.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.password_create.inputs.password.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.password_create.inputs.password","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.password_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.password_create","typeLabel":"object"},"password_update":{"type":"object","description":"Update a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_update"],"uniqueKey":"oneOf.0.actions.password_update.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.password_update.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.password_update.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"password":{"type":"object","properties":{"name":{"type":"string","enum":["password"],"uniqueKey":"oneOf.0.actions.password_update.inputs.password.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["password"],"uniqueKey":"oneOf.0.actions.password_update.inputs.password.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.password_update.inputs.password.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":8,"uniqueKey":"oneOf.0.actions.password_update.inputs.password.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.password_update.inputs.password.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.password_update.inputs.password.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.password_update.inputs.password.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.password_update.inputs.password.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.password_update.inputs.password.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.password_update.inputs.password.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.password_update.inputs.password.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.password_update.inputs.password","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.password_update.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.password_update","typeLabel":"object"},"password_delete":{"type":"object","description":"Delete a password.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["password_delete"],"uniqueKey":"oneOf.0.actions.password_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.password_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.password_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.password_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.password_delete","typeLabel":"object"},"patch_metadata":{"type":"object","description":"Patches the (unsafe) metadata of a user.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["patch_metadata"],"uniqueKey":"oneOf.0.actions.patch_metadata.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.patch_metadata.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.patch_metadata.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"patch_metadata":{"type":"object","properties":{"name":{"type":"string","enum":["patch_metadata"],"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["json"],"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.patch_metadata.inputs.patch_metadata","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.patch_metadata.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.patch_metadata","typeLabel":"object"},"security_key_create":{"type":"object","description":"Create a security key.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["security_key_create"],"uniqueKey":"oneOf.0.actions.security_key_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.security_key_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.security_key_create.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.security_key_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.security_key_create","typeLabel":"object"},"security_key_delete":{"type":"object","description":"Delete a security key.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["security_key_delete"],"uniqueKey":"oneOf.0.actions.security_key_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.security_key_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.security_key_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"security_key_id":{"type":"object","properties":{"name":{"type":"string","enum":["security_key_id"],"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.security_key_delete.inputs.security_key_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.security_key_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.security_key_delete","typeLabel":"object"},"session_delete":{"type":"object","description":"Revoke a session.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["session_delete"],"uniqueKey":"oneOf.0.actions.session_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.session_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.session_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","properties":{"session_id":{"type":"object","properties":{"name":{"type":"string","enum":["session_id"],"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id.allowed_values","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.actions.session_delete.inputs.session_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.session_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.session_delete","typeLabel":"object"},"username_set":{"type":"object","description":"Set a username.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["username_set"],"uniqueKey":"oneOf.0.actions.username_set.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.username_set.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.username_set.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["username"],"properties":{"username":{"type":"object","title":"Username","properties":{"name":{"type":"string","enum":["username"],"uniqueKey":"oneOf.0.actions.username_set.inputs.username.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.username_set.inputs.username.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.username_set.inputs.username.required","typeLabel":"boolean"},"min_length":{"type":"integer","enum":[3],"uniqueKey":"oneOf.0.actions.username_set.inputs.username.min_length","typeLabel":"enum\u003cinteger>"},"max_length":{"type":"integer","enum":[40],"uniqueKey":"oneOf.0.actions.username_set.inputs.username.max_length","typeLabel":"enum\u003cinteger>"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.username_set.inputs.username.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.username_set.inputs.username.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.username_set.inputs.username.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.username_set.inputs.username.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.username_set.inputs.username.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.username_set.inputs.username.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.username_set.inputs.username","typeLabel":"Username · object"}},"uniqueKey":"oneOf.0.actions.username_set.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.username_set","typeLabel":"object"},"username_delete":{"type":"object","description":"Delete a username.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["username_create"],"uniqueKey":"oneOf.0.actions.username_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.username_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.username_delete.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.username_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.username_delete","typeLabel":"object"},"webauthn_credential_rename":{"type":"object","description":"Rename a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_rename"],"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["passkey_id","passkey_name"],"properties":{"passkey_id":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_id"],"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_id","typeLabel":"object"},"passkey_name":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_name"],"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs.passkey_name","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_rename","typeLabel":"object"},"webauthn_credential_create":{"type":"object","description":"Generate passkey creation options for registering a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_create"],"uniqueKey":"oneOf.0.actions.webauthn_credential_create.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_create.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_create.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.0.actions.webauthn_credential_create.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_create","typeLabel":"object"},"webauthn_credential_delete":{"type":"object","description":"Delete a passkey.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_credential_delete"],"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["passkey_id"],"properties":{"passkey_id":{"type":"object","properties":{"name":{"type":"string","enum":["passkey_id"],"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs.passkey_id","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_delete.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions.webauthn_credential_delete","typeLabel":"object"}},"uniqueKey":"oneOf.0.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["profile_init"],"uniqueKey":"oneOf.0.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","properties":{"user":{"description":"Data pertaining to the user associated with the current session.","type":"object","properties":{"user_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.user_id","typeLabel":"string\u003cuuid>"},"passkeys":{"type":"array","items":{"type":"object","properties":{"aaguid":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].aaguid","typeLabel":"string\u003cuuid>"},"attestation_type":{"type":"string","enum":["none","packed","tpm","android-key","android-safetynet","fido-u2f","apple"],"uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].attestation_type","typeLabel":"enum\u003cstring>"},"backup_eligible":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].backup_eligible","typeLabel":"boolean"},"backup_state":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].backup_state","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"last_used_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"},"mfa_only":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].mfa_only","typeLabel":"boolean"},"public-key":{"type":"string","uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].public-key","typeLabel":"string"},"transports":{"type":"array","items":{"type":"string","enum":["ble","internal","nfc","usb"],"uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].transports.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX].transports","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"oneOf.0.payload.user.passkeys.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.user.passkeys","typeLabel":"object[]"},"security_keys":{"type":"array","items":{"type":"object","properties":{"aaguid":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].aaguid","typeLabel":"string\u003cuuid>"},"attestation_type":{"type":"string","enum":["none","packed","tpm","android-key","android-safetynet","fido-u2f","apple"],"uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].attestation_type","typeLabel":"enum\u003cstring>"},"backup_eligible":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].backup_eligible","typeLabel":"boolean"},"backup_state":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].backup_state","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"last_used_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"},"mfa_only":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].mfa_only","typeLabel":"boolean"},"public-key":{"type":"string","uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].public-key","typeLabel":"string"},"transports":{"type":"array","items":{"type":"string","enum":["ble","internal","nfc","usb"],"uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].transports.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX].transports","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"oneOf.0.payload.user.security_keys.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.user.security_keys","typeLabel":"object[]"},"emails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"address":{"type":"string","format":"email","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].address","typeLabel":"string\u003cemail>"},"is_primary":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].is_primary","typeLabel":"boolean"},"is_verified":{"type":"boolean","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].is_verified","typeLabel":"boolean"},"identity":{"deprecated":true,"description":"Deprecated. See `identities` instead.","type":"object","properties":{"id":{"type":"string","description":"Contains the ID of the user at the provider.","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identity.id","typeLabel":"string"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identity.provider","typeLabel":"string"}},"uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identity","typeLabel":"object"},"identities":{"deprecated":true,"description":"Deprecated. See top-level `identities` instead.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user at the provider","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identities.items.[INDEX].id","typeLabel":"string"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identities.items.[INDEX].provider","typeLabel":"string"}},"uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX].identities","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.payload.user.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.user.emails","typeLabel":"object[]"},"identities":{"description":"The user's third party connections/identities.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the user at the provider","uniqueKey":"oneOf.0.payload.user.identities.items.[INDEX].id","typeLabel":"string"},"identity_id":{"type":"string","description":"The identity's ID","format":"uuid4","uniqueKey":"oneOf.0.payload.user.identities.items.[INDEX].identity_id","typeLabel":"string\u003cuuid4>"},"provider":{"type":"string","description":"Contains the display name of the provider, if available. Otherwise contains the provider ID.\n","uniqueKey":"oneOf.0.payload.user.identities.items.[INDEX].provider","typeLabel":"string"}},"uniqueKey":"oneOf.0.payload.user.identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.user.identities","typeLabel":"object[]"},"metadata":{"type":"object","properties":{"public_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.payload.user.metadata.public_metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.payload.user.metadata.public_metadata","typeLabel":"object"},"unsafe_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.payload.user.metadata.unsafe_metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.payload.user.metadata.unsafe_metadata","typeLabel":"object"}},"uniqueKey":"oneOf.0.payload.user.metadata","typeLabel":"object"},"mfa_config":{"type":"object","properties":{"auth_app_set_up":{"type":"boolean","description":"Indicates whether the user has set up an authenticator app for 2FA.","uniqueKey":"oneOf.0.payload.user.mfa_config.auth_app_set_up","typeLabel":"boolean"},"totp_enabled":{"type":"boolean","description":"Indicates whether 2FA via authenticator app is enabled on this tenant. \n\nTo check whether a user has set up an authenticator app for 2FA, see `payload.user.mfa_config.auth_app_set_up`.\n","uniqueKey":"oneOf.0.payload.user.mfa_config.totp_enabled","typeLabel":"boolean"},"security_keys_enabled":{"type":"boolean","description":"Indicates whether 2FA via security keys is enabled on this tenant.\n\nTo check whether a user has enrolled security keys for 2FA, see `payload.user.security_keys`.\n","uniqueKey":"oneOf.0.payload.user.mfa_config.security_keys_enabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.payload.user.mfa_config","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.user.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","uniqueKey":"oneOf.0.payload.user.name","typeLabel":"string"},"given_name":{"type":"string","uniqueKey":"oneOf.0.payload.user.given_name","typeLabel":"string"},"family_name":{"type":"string","uniqueKey":"oneOf.0.payload.user.family_name","typeLabel":"string"},"picture":{"type":"string","format":"uri","uniqueKey":"oneOf.0.payload.user.picture","typeLabel":"string\u003curi>"}},"uniqueKey":"oneOf.0.payload.user","typeLabel":"object"},"sessions":{"description":"List of active sessions for this user.","type":"array","items":{"type":"object","properties":{"created_at":{"description":"Time of creation of the session.","type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"current":{"description":"Indicates whether this session is the session currently used.","type":"boolean","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].current","typeLabel":"boolean"},"expires_at":{"description":"Time of expiry of the session.","type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"The ID of the session.","type":"string","format":"uuid","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"ip_address":{"oneOf":[{"type":"string","description":"IPv4 address the session was initialized from.","format":"ipv4","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].ip_address.oneOf.0","typeLabel":"string\u003cipv4>"},{"type":"string","description":"IPv6 address the session was initialized from.","format":"ipv6","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].ip_address.oneOf.1","typeLabel":"string\u003cipv6>"}],"uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].ip_address","typeLabel":"string\u003cipv4> | string\u003cipv6>"},"last_used":{"description":"Time of last usage of this session.","type":"string","format":"date-time","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].last_used","typeLabel":"string\u003cdate-time>"},"user_agent":{"description":"User agent string consisting of the native platform that the browser is running on (Windows, Mac, \nLinux, Android, etc.) and a parenthesised name of the user agent.\n","type":"string","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].user_agent","typeLabel":"string"},"user_agent_raw":{"description":"The complete user agent, i.e. the exact value of the `User-Agent` header the API received\nin the request(s) for establishing the session.\n","type":"string","uniqueKey":"oneOf.0.payload.sessions.items.[INDEX].user_agent_raw","typeLabel":"string"}},"uniqueKey":"oneOf.0.payload.sessions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.payload.sessions","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[],"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.0.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.0.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.0.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.links","typeLabel":"object[] | null"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"oneOf.0.error.cause","typeLabel":"string"}},"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"ProfileInit · object"},{"type":"object","title":"PasscodeConfirmation","properties":{"actions":{"type":"object","description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","properties":{"verify_passcode":{"type":"object","description":"Verify a passcode.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["verify_passcode"],"uniqueKey":"oneOf.1.actions.verify_passcode.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.verify_passcode.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.verify_passcode.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["code"],"properties":{"code":{"type":"object","properties":{"name":{"type":"string","enum":["code"],"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["string"],"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.required","typeLabel":"boolean"},"min_length":{"type":"integer","default":6,"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.min_length","typeLabel":"integer"},"max_length":{"type":"integer","default":6,"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":false,"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.actions.verify_passcode.inputs.code","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.verify_passcode.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.verify_passcode","typeLabel":"object"},"resend_passcode":{"type":"object","description":"Resend a passcode.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["resend_passcode"],"uniqueKey":"oneOf.1.actions.resend_passcode.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.resend_passcode.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.resend_passcode.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.resend_passcode.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.resend_passcode","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.1.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.1.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.1.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.1.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.1.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["passcode_confirmation"],"uniqueKey":"oneOf.1.name","typeLabel":"enum\u003cstring>"},"payload":{"description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","type":"object","uniqueKey":"oneOf.1.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[],"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.1.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.1.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.1.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.links","typeLabel":"object[] | null"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"oneOf.1.error.cause","typeLabel":"string"}},"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"PasscodeConfirmation · object"},{"type":"object","title":"ProfileWebauthnCredentialVerification","properties":{"actions":{"type":"object","description":"ActionsWebauthnVerifyAttestationResponse","properties":{"webauthn_verify_attestation_response":{"type":"object","description":"Verify an attestation response to complete a passkey registration.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["webauthn_verify_attestation_response"],"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.description","typeLabel":"string"},"inputs":{"type":"object","description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","required":["public_key"],"properties":{"public_key":{"type":"object","properties":{"name":{"type":"string","enum":["public-key"],"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.name","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["json"],"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":true,"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.required","typeLabel":"boolean"},"min_length":{"type":"integer","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.min_length","typeLabel":"integer"},"max_length":{"type":"integer","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.max_length","typeLabel":"integer"},"hidden":{"type":"boolean","default":true,"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.hidden","typeLabel":"boolean"},"value":{"type":"string","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.value","typeLabel":"string"},"allowed_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Can be any value - string, number, boolean, array or object.","uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key.allowed_values","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs.public_key","typeLabel":"object"}},"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.2.actions.webauthn_verify_attestation_response","typeLabel":"object"},"back":{"type":"object","description":"Go back to the previous state.","properties":{"action":{"type":"string","description":"The name of the action.","enum":["back"],"uniqueKey":"oneOf.2.actions.back.action","typeLabel":"enum\u003cstring>"},"href":{"description":"The action target as a URL relative to the API tenant base URL.","type":"string","uniqueKey":"oneOf.2.actions.back.href","typeLabel":"string"},"description":{"description":"The description for the action.","type":"string","uniqueKey":"oneOf.2.actions.back.description","typeLabel":"string"},"inputs":{"description":"The inputs for the action. \n\nAn input indicates that when making a request to perform an action, the `input_data` value of the \nrequest body must contain a key with the given `name` value of the respective input. The corresponding \nvalue for that key is specified by the remaining properties of the input.\n","type":"object","uniqueKey":"oneOf.2.actions.back.inputs","typeLabel":"object"}},"uniqueKey":"oneOf.2.actions.back","typeLabel":"object"}},"uniqueKey":"oneOf.2.actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["webauthn_credential_verification"],"uniqueKey":"oneOf.2.name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","required":["creation_options"],"properties":{"creation_options":{"description":"Options for credential creation with the WebAuthn API","externalDocs":{"url":"https://www.w3.org/TR/webauthn-2/#dictionary-makecredentialoptions"},"type":"object","properties":{"publicKey":{"type":"object","properties":{"rp":{"type":"object","properties":{"name":{"type":"string","example":"Hanko Authentication Service","uniqueKey":"oneOf.2.payload.creation_options.publicKey.rp.name","typeLabel":"string"},"id":{"type":"string","example":"localhost","uniqueKey":"oneOf.2.payload.creation_options.publicKey.rp.id","typeLabel":"string"}},"uniqueKey":"oneOf.2.payload.creation_options.publicKey.rp","typeLabel":"object"},"user":{"type":"object","properties":{"id":{"type":"string","example":"pPQT9rwJRD7gVncsnCDNyN","uniqueKey":"oneOf.2.payload.creation_options.publicKey.user.id","typeLabel":"string"},"name":{"type":"string","example":"user@example.com","uniqueKey":"oneOf.2.payload.creation_options.publicKey.user.name","typeLabel":"string"},"displayName":{"type":"string","example":"user@example.com","uniqueKey":"oneOf.2.payload.creation_options.publicKey.user.displayName","typeLabel":"string"}},"uniqueKey":"oneOf.2.payload.creation_options.publicKey.user","typeLabel":"object"},"challenge":{"type":"string","format":"base64url","example":"7qmkJUXR0dOFnsW48evX3qKdCzlGjvvqAAvMDN+KTN0=","uniqueKey":"oneOf.2.payload.creation_options.publicKey.challenge","typeLabel":"string\u003cbase64url>"},"pubKeyCredParams":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["public-key"],"uniqueKey":"oneOf.2.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"alg":{"type":"number","uniqueKey":"oneOf.2.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX].alg","typeLabel":"number"}},"uniqueKey":"oneOf.2.payload.creation_options.publicKey.pubKeyCredParams.items.[INDEX]","typeLabel":"object"},"example":[{"type":"public-key","alg":-7}],"uniqueKey":"oneOf.2.payload.creation_options.publicKey.pubKeyCredParams","typeLabel":"object[]"},"timeout":{"type":"number","format":"int64","example":60000,"uniqueKey":"oneOf.2.payload.creation_options.publicKey.timeout","typeLabel":"number\u003cint64>"},"authenticatorSelection":{"type":"object","properties":{"authenticatorAttachment":{"type":"string","enum":["platform","cross-platform"],"example":"platform","uniqueKey":"oneOf.2.payload.creation_options.publicKey.authenticatorSelection.authenticatorAttachment","typeLabel":"enum\u003cstring>"},"requireResidentKey":{"type":"boolean","example":true,"uniqueKey":"oneOf.2.payload.creation_options.publicKey.authenticatorSelection.requireResidentKey","typeLabel":"boolean"},"residentKey":{"type":"string","enum":["discouraged","preferred","required"],"example":"preferred","uniqueKey":"oneOf.2.payload.creation_options.publicKey.authenticatorSelection.residentKey","typeLabel":"enum\u003cstring>"},"userVerification":{"type":"string","enum":["discouraged","preferred","required"],"example":"required","uniqueKey":"oneOf.2.payload.creation_options.publicKey.authenticatorSelection.userVerification","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.payload.creation_options.publicKey.authenticatorSelection","typeLabel":"object"},"attestation":{"type":"string","enum":["none","indirect","direct","enterprise"],"example":"none","uniqueKey":"oneOf.2.payload.creation_options.publicKey.attestation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.payload.creation_options.publicKey","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.2.payload.creation_options","typeLabel":"object"}},"uniqueKey":"oneOf.2.payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[],"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"oneOf.2.csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"oneOf.2.links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"oneOf.2.links.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.links","typeLabel":"object[] | null"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"oneOf.2.error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"oneOf.2.error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"oneOf.2.error.cause","typeLabel":"string"}},"uniqueKey":"oneOf.2.error","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"ProfileWebauthnCredentialVerification · object"}],"uniqueKey":"","typeLabel":"ProfileInit · object | PasscodeConfirmation · object | ProfileWebauthnCredentialVerification · object"},"examples":{"Example":{"title":"Example","value":{"actions":{"account_delete":{"action":"account_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"connect_thirdparty_oauth_provider":{"action":"connect_thirdparty_oauth_provider","href":"\u003cstring>","description":"\u003cstring>","inputs":{"provider":{"name":"provider","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"apple"}]},"redirect_to":{"name":"redirect_to","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]},"code_verifier":{"name":"code_verifier","type":"string","required":false,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"continue_to_otp_secret_creation":{"action":"continue_to_otp_secret_creation","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"disconnect_thirdparty_oauth_provider":{"action":"disconnect_thirdparty_oauth_provider","href":"\u003cstring>","description":"\u003cstring>","inputs":{"identity_id":"\u003cstring>"}},"email_create":{"action":"email_create","href":"\u003cstring>","description":"\u003cstring>","inputs":{"email":{"name":"email","type":"email","required":true,"min_length":123,"max_length":120,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"email_delete":{"action":"email_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{"email_id":{"name":"email_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"email_set_primary":{"action":"email_set_primary","href":"\u003cstring>","description":"\u003cstring>","inputs":{"email_id":{"name":"email_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"email_verify":{"action":"email_verify","href":"\u003cstring>","description":"\u003cstring>","inputs":{"email_id":{"name":"email_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"otp_secret_delete":{"action":"otp_secret_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"password_create":{"action":"password_create","href":"\u003cstring>","description":"\u003cstring>","inputs":{"password":{"name":"password","type":"password","required":true,"min_length":8,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"password_update":{"action":"password_update","href":"\u003cstring>","description":"\u003cstring>","inputs":{"password":{"name":"password","type":"password","required":true,"min_length":8,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"password_delete":{"action":"password_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"patch_metadata":{"action":"patch_metadata","href":"\u003cstring>","description":"\u003cstring>","inputs":{"patch_metadata":{"name":"patch_metadata","type":"json","required":true,"min_length":123,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"security_key_create":{"action":"security_key_create","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"security_key_delete":{"action":"security_key_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{"security_key_id":{"name":"security_key_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"session_delete":{"action":"session_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{"session_id":{"name":"session_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":true,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"username_set":{"action":"username_set","href":"\u003cstring>","description":"\u003cstring>","inputs":{"username":{"name":"username","type":"string","required":false,"min_length":3,"max_length":40,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"username_delete":{"action":"username_create","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"webauthn_credential_rename":{"action":"webauthn_credential_rename","href":"\u003cstring>","description":"\u003cstring>","inputs":{"passkey_id":{"name":"passkey_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]},"passkey_name":{"name":"passkey_name","type":"string","required":true,"min_length":123,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}},"webauthn_credential_create":{"action":"webauthn_credential_create","href":"\u003cstring>","description":"\u003cstring>","inputs":{}},"webauthn_credential_delete":{"action":"webauthn_credential_delete","href":"\u003cstring>","description":"\u003cstring>","inputs":{"passkey_id":{"name":"passkey_id","type":"string","required":true,"min_length":123,"max_length":123,"hidden":false,"value":"\u003cstring>","allowed_values":[{"name":"\u003cstring>","value":"\u003cunknown>"}]}}}},"name":"profile_init","payload":{"user":{"user_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","passkeys":[{"aaguid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","attestation_type":"none","backup_eligible":true,"backup_state":true,"created_at":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","last_used_at":"2023-11-07T05:31:56Z","mfa_only":true,"public-key":"\u003cstring>","transports":["ble"]}],"security_keys":[{"aaguid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","attestation_type":"none","backup_eligible":true,"backup_state":true,"created_at":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","last_used_at":"2023-11-07T05:31:56Z","mfa_only":true,"public-key":"\u003cstring>","transports":["ble"]}],"emails":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","address":"jsmith@example.com","is_primary":true,"is_verified":true,"identity":{"id":"\u003cstring>","provider":"\u003cstring>"},"identities":[{"id":"\u003cstring>","provider":"\u003cstring>"}]}],"identities":[{"id":"\u003cstring>","identity_id":"\u003cstring>","provider":"\u003cstring>"}],"metadata":{"public_metadata":{},"unsafe_metadata":{}},"mfa_config":{"auth_app_set_up":true,"totp_enabled":true,"security_keys_enabled":true},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","name":"\u003cstring>","given_name":"\u003cstring>","family_name":"\u003cstring>","picture":"\u003cstring>"},"sessions":[{"created_at":"2023-11-07T05:31:56Z","current":true,"expires_at":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ip_address":"127.0.0.1","last_used":"2023-11-07T05:31:56Z","user_agent":"\u003cstring>","user_agent_raw":"\u003cstring>"}]},"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"\u003cstring>","message":"\u003cstring>","cause":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1c6461c0-062a-45a6-bd84-5375757e295e":{"description":"FlowResponseUnauthorizedError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[401],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"passcode_max_attempts_reached","message":"The passcode was entered wrong too many times."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{},"status":401,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"passcode_max_attempts_reached","message":"The passcode was entered wrong too many times."}}}},"exampleType":"generated"}},"exampleType":"generated"},"6b806e58-fbcc-4926-b783-429f0da439e7":{"description":"FlowResponseForbiddenError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[403],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"operation_not_permitted_error","message":"The flow is not permitted."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{},"status":403,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"operation_not_permitted_error","message":"The flow is not permitted."}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f83d7c5-a7a4-4069-80a5-2ac536067dab":{"description":"FlowResponseNotFoundError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[404],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"not_found","message":"The requested resource was not found."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{},"status":404,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"not_found","message":"The requested resource was not found."}}}},"exampleType":"generated"}},"exampleType":"generated"},"ec7f4afc-3630-4f0a-a04e-ce535fabc046":{"description":"FlowResponseGoneError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[410],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"flow_expired_error","message":"The flow has expired."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{},"status":410,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"flow_expired_error","message":"The flow has expired."}}}},"exampleType":"generated"}},"exampleType":"generated"},"80af2ca7-0119-46f8-bfaf-cd6d862dffc6":{"description":"FlowResponseTooManyRequestsError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Returned with a flow response when the request rate limit was exceeded.","properties":{"resend_after":{"description":"Indicates the amount of seconds required to pass in order to be able to send another request.\n","type":"integer","example":60,"uniqueKey":"payload.resend_after","typeLabel":"integer"}},"uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[429],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"rate_limit_exceeded","message":"The rate limit has been exceeded."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{"resend_after":60},"status":429,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"rate_limit_exceeded","message":"The rate limit has been exceeded."}}}},"exampleType":"generated"}},"exampleType":"generated"},"f030bdb3-89ec-461f-b332-62f13d5a544f":{"description":"FlowResponseInternalServerError","content":{"application/json":{"schema":{"type":"object","title":"Error","properties":{"actions":{"description":"List of actions that can be performed in the current flow state in order to advance the flow to the next \nstate.\n\nDepending on user details (e.g. presence or absence of credentials) or the tenant's configuration \nsome actions may or may not be present in the response.\n","type":"object","uniqueKey":"actions","typeLabel":"object"},"name":{"type":"string","description":"The name of the flow state.","enum":["error"],"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","description":"Additional data that can be used by the client (e.g. `user` or `sessions` data provided in the\nprofile flow) or should/must be used as intermediary data in an out of band process to produce input data \nfor advancing the flow (e.g. the WebAuthn credential request/creation options that must be passed to the \nWebauthn API to produce an assertion/attestation).\n","uniqueKey":"payload","typeLabel":"object"},"status":{"type":"integer","description":"The HTTP response status code for this flow response.","enum":[500],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"csrf_token":{"description":"Token to prevent Cross-Site Request Forgeries.","type":"string","example":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","uniqueKey":"csrf_token","typeLabel":"string"},"links":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].name","typeLabel":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri","uniqueKey":"links.oneOf.0.items.[INDEX].href","typeLabel":"string\u003curi>"},"category":{"description":"The category of the link.","type":"string","uniqueKey":"links.oneOf.0.items.[INDEX].category","typeLabel":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"],"uniqueKey":"links.oneOf.0.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"uniqueKey":"links.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"links.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"description":"The name of the link.","type":"string"},"href":{"description":"The destination of the link.","type":"string","format":"uri"},"category":{"description":"The category of the link.","type":"string"},"target":{"description":"The target of the link.","type":"string","enum":["_self","_blank","_parent","_top"]}}},"example":[],"uniqueKey":"links.oneOf.1","typeLabel":"null"}],"uniqueKey":"links","typeLabel":"object[] | null"},"error":{"type":"object","example":{"code":"technical_error","message":"Something went wrong."},"properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"cause":{"type":"string","uniqueKey":"error.cause","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Example":{"title":"Example","value":{"actions":{},"name":"error","payload":{},"status":500,"csrf_token":"HvUwWSfPgz7VnwiS8VMDpnhZ1wNwTNiV","links":[],"error":{"code":"technical_error","message":"Something went wrong."}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"82c1c49a-3e08-4046-b26a-202b56d36371":{"CookieAuth":{"type":"apiKey","in":"cookie","name":"hanko","scopes":[],"schemeName":"CookieAuth"}},"2a0eb107-21aa-4beb-968f-487cb4113bb9":{"BearerTokenAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerTokenAuth"}}},"servers":{"13180741-3fb2-490c-8642-e04385305008":{"url":"https://{tenant_id}.hanko.io","variables":{"tenant_id":{"default":"","description":"The (UU)ID of a tenant. Replace the default value with your tenant ID."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"hanko","scopes":[],"schemeName":"CookieAuth"},"schema":{"title":"hanko","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"CookieAuth","name":"hanko"}],"title":"CookieAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerTokenAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerTokenAuth","name":"Authorization"}],"title":"BearerTokenAuth"}]},"originalFileLocation":"openapi-flow.yaml"},"subdomain":"hanko","siteName":"Hanko","title":"Profile - Hanko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-18T08:41:22.495Z","originalFileLocation":"api-reference/flow/profile.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Initialize or advance a profile flow.\">\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=\"Profile - Hanko\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initialize or advance a profile flow.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hanko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hanko.io/api-reference/flow/profile\">\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=Flow\u0026amp;title=Profile\u0026amp;description=Initialize+or+advance+a+profile+flow.\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=87177bcdb4a9706730b03b674f8fd009abd7d3a01ecf182c49a6b617f265ebc8\">\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=\"Profile - Hanko\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initialize or advance a profile flow.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hanko.mintlify.app/_mintlify/api/og/v2?division=Flow\u0026amp;title=Profile\u0026amp;description=Initialize+or+advance+a+profile+flow.\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=87177bcdb4a9706730b03b674f8fd009abd7d3a01ecf182c49a6b617f265ebc8\">\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/flow/profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/flow/profile.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/flow/profile#webpage\",\"url\":\"https://docs.hanko.io/api-reference/flow/profile\",\"name\":\"Profile\",\"description\":\"Initialize or advance a profile flow.\",\"dateModified\":\"2025-08-18T08:41:22.495Z\",\"isPartOf\":{\"@id\":\"https://docs.hanko.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hanko.io/api-reference/flow/profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hanko.io/api-reference/flow/profile#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\":\"Public\",\"item\":\"https://docs.hanko.io/api-reference/flow/registration\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Flow\",\"item\":\"https://docs.hanko.io/api-reference/flow/registration\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Profile\",\"item\":\"https://docs.hanko.io/api-reference/flow/profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hanko.io/api-reference/flow/profile#apireference\",\"headline\":\"Profile\",\"name\":\"Profile\",\"description\":\"Initialize or advance a profile flow.\",\"url\":\"https://docs.hanko.io/api-reference/flow/profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hanko.io/api-reference/flow/profile#webpage\"},\"dateModified\":\"2025-08-18T08:41:22.495Z\",\"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","description":"Initialize or advance a login flow.","href":"/api-reference/flow/login"},{"openapi":"post /profile","title":"Profile","href":"/api-reference/flow/profile"},{"openapi":"post /token_exchange","description":"Initialize or advance a token exchange flow.","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"},{"openapi":"openapi-public post /thirdparty/callback","title":"Third party provider form callback","href":"/api-reference/public/third-party/third-party-provider-form-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","pages":[{"title":"Passkey API Docs","href":"/passkey-api/introduction"}]},{"tab":"Hanko Authenticator Docs","pages":[{"title":"Hanko Authenticator Docs","href":"/hanko-authenticator/introduction"}]}]},"basePath":"","title":"Profile - Hanko","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}