Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.
Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.
Required range: x <= 2147483647
⌘I
{"docsConfig":{"theme":"linden","$schema":"https://mintlify.com/docs.json","name":"Kaizen","colors":{"primary":"#ffcc00","light":"#ffcc00","dark":"#f8c806"},"logo":{"light":"https://mintcdn.com/kaizenautomation/Wx0TyKIp-iSVxHVM/logo/light.svg?fit=max\u0026auto=format\u0026n=Wx0TyKIp-iSVxHVM\u0026q=85\u0026s=f3e4d00ffe0f3d46f58a68a433349b22","dark":"https://mintcdn.com/kaizenautomation/Wx0TyKIp-iSVxHVM/logo/dark.svg?fit=max\u0026auto=format\u0026n=Wx0TyKIp-iSVxHVM\u0026q=85\u0026s=c9e7c7a28d2d044f4ae76f7d7ba5a895"},"favicon":"https://mintcdn.com/kaizenautomation/Wx0TyKIp-iSVxHVM/favicon.svg?fit=max\u0026auto=format\u0026n=Wx0TyKIp-iSVxHVM\u0026q=85\u0026s=38fa31b283b9dce54a99fa12128c17c9","styling":{"latex":false},"background":{"color":{"light":"#fffdf7","dark":"#100f0b"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kaizenautomation","hasAudioNarration":false,"actualSubdomain":"kaizenautomation","customDomains":["docs.kaizenautomation.com"],"gitSource":{"type":"github","owner":"kaizen-automation","repo":"kaizen","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeae68c1dc8750e81171b30","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Agents","count":5},{"language":"default","tag":"Logins","count":5},{"language":"default","tag":"Workflows","count":4},{"language":"default","tag":"Cookbook","count":4},{"language":"default","tag":"Executions","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Authentication","count":2},{"language":"default","tag":"Files","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"editor-metadata","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":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/logins/create-a-login","slug":"/api-reference/logins/create-a-login","pageMetadata":{"openapi":"post /logins/create","title":"Create a login","description":"Creates a new login with required credentials","href":"/api-reference/logins/create-a-login"},"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: \"Creates a new login with required credentials\"\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 /logins/create","title":"Create a login","description":"Creates a new login with required credentials","href":"/api-reference/logins/create-a-login"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/kaizenautomation/306b5f73ebd5ade6/scripts/generate-docs.js"],"openApiReferenceData":{"operation":{"summary":"Create a login","description":"Creates a new login with required credentials","tags":["Logins"],"requestBody":"f5c48666-4649-4a37-af33-b3a4d2282edb","responses":{"201":"d5e0b4f4-0d5e-4dd6-a4cd-4fe0fe28c346","400":"4e38e10d-a613-45d9-bd5a-677c43c6a8ca"},"method":"post","type":"path","servers":["9a402b36-c691-4e99-be7b-195e4566257b"],"security":[],"path":"/logins/create","baseUrlOptions":["https://api.kaizenautomation.com"],"title":"Create a login","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Login creation parameters","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Name of the login for identification","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"authenticationUrl":{"type":"string","description":"URL of the authentication page","isRequired":true,"uniqueKey":"authenticationUrl","typeLabel":"string"},"homeUrl":{"type":"string","description":"URL of the home page of the domain","isRequired":true,"uniqueKey":"homeUrl","typeLabel":"string"},"loginConfiguration":{"type":"object","properties":{"username":{"type":"string","description":"Username for authentication","uniqueKey":"loginConfiguration.username","typeLabel":"string"},"twoFactorAuthConfiguration":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","enum":["Email","SMS","TOTP"],"description":"Method used for 2FA verification","isRequired":true,"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.method","typeLabel":"enum\u003cstring>"},"alwaysRequired":{"type":"boolean","description":"Whether 2FA is always required, if it is not, the workflow will make a determination based upon the text displayed on the site.","isRequired":true,"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.alwaysRequired","typeLabel":"boolean"},"twoFactorAuthEmail":{"type":"string","description":"The email which the 2FA codes will be sent to, which our system will use to associate to the created login. Required when method is Email.","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.twoFactorAuthEmail","typeLabel":"string"},"totpSecretKey":{"type":"string","description":"Secret key used for TOTP generation. REQUIRED when method is TOTP, optional otherwise. This key is used to generate time-based one-time passwords for authentication.","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.totpSecretKey","typeLabel":"string"}},"required":["method","alwaysRequired"],"description":"Configuration for two-factor authentication including sensitive credentials","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"method":{"type":"string","enum":["Email","SMS","TOTP"],"description":"Method used for 2FA verification"},"alwaysRequired":{"type":"boolean","description":"Whether 2FA is always required, if it is not, the workflow will make a determination based upon the text displayed on the site."},"twoFactorAuthEmail":{"type":"string","description":"The email which the 2FA codes will be sent to, which our system will use to associate to the created login. Required when method is Email."},"totpSecretKey":{"type":"string","description":"Secret key used for TOTP generation. REQUIRED when method is TOTP, optional otherwise. This key is used to generate time-based one-time passwords for authentication."}},"required":["method","alwaysRequired"],"description":"Configuration for two-factor authentication including sensitive credentials","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration","typeLabel":"object | null"},"additionalCredentials":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key for the additional credential","isRequired":true,"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the additional credential","isRequired":true,"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].value","typeLabel":"string"},"id":{"type":"string","description":"Unique identifier for the additional credential","uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].id","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX]","typeLabel":"object"},"description":"Additional key-value credentials","uniqueKey":"loginConfiguration.additionalCredentials","typeLabel":"object[]"},"password":{"type":"string","description":"Password for authentication. Required for login credential types, optional for API keys and bearer tokens.","uniqueKey":"loginConfiguration.password","typeLabel":"string"}},"description":"Values for fields required to complete authentication, including sensitive credentials.","isRequired":true,"uniqueKey":"loginConfiguration","typeLabel":"object"},"iconUrl":{"type":"string","maxLength":700000,"description":"Optional icon URL or data URL for the login logo.","uniqueKey":"iconUrl","typeLabel":"string"},"persistSession":{"type":"boolean","description":"Whether to persist the session after authentication","uniqueKey":"persistSession","typeLabel":"boolean"},"isManualAuthentication":{"type":"boolean","default":false,"description":"Whether this login requires manual authentication","uniqueKey":"isManualAuthentication","typeLabel":"boolean"},"useLLMLoginDetection":{"type":"boolean","description":"Whether to use LLM-powered login detection. If false, uses URL-based detection instead.","uniqueKey":"useLLMLoginDetection","typeLabel":"boolean"},"loginDetectionPrompt":{"type":"string","description":"Custom prompt to use for LLM-based login detection. Describes what the logged-out experience looks like.","uniqueKey":"loginDetectionPrompt","typeLabel":"string"},"loginInstructionsPrompt":{"type":"string","description":"Custom instructions for the login agent. Provides guidance on how to complete the login flow for this specific site.","uniqueKey":"loginInstructionsPrompt","typeLabel":"string"},"supportConcurrentLogins":{"type":"boolean","description":"Whether to allow concurrent logins using this login. When false, a lock is acquired before login to prevent simultaneous sessions.","uniqueKey":"supportConcurrentLogins","typeLabel":"boolean"},"sessionExpiryMinutes":{"oneOf":[{"type":"integer","maximum":2147483647,"description":"Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.","uniqueKey":"sessionExpiryMinutes.oneOf.0","typeLabel":"integer"},{"type":"null","maximum":2147483647,"description":"Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.","uniqueKey":"sessionExpiryMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionExpiryMinutes","typeLabel":"integer | null"},"autoRetryOnServiceDown":{"type":"boolean","description":"Whether to automatically retry scheduled executions when the target service appears to be down.","uniqueKey":"autoRetryOnServiceDown","typeLabel":"boolean"},"autoRetryDelayMinutes":{"type":"integer","minimum":1,"description":"Number of minutes to wait before retrying when service down is detected. Defaults to 30.","uniqueKey":"autoRetryDelayMinutes","typeLabel":"integer"},"autoRetryMaxAttempts":{"type":"integer","minimum":1,"description":"Maximum number of service-down retry attempts before giving up. Defaults to 3.","uniqueKey":"autoRetryMaxAttempts","typeLabel":"integer"}},"required":["name","authenticationUrl","homeUrl","loginConfiguration"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","authenticationUrl":"\u003cstring>","homeUrl":"\u003cstring>","loginConfiguration":{"username":"\u003cstring>","twoFactorAuthConfiguration":{"alwaysRequired":true,"twoFactorAuthEmail":"\u003cstring>","totpSecretKey":"\u003cstring>"},"additionalCredentials":[{"key":"\u003cstring>","value":"\u003cstring>","id":"\u003cstring>"}],"password":"\u003cstring>"},"iconUrl":"\u003cstring>","persistSession":true,"isManualAuthentication":false,"useLLMLoginDetection":true,"loginDetectionPrompt":"\u003cstring>","loginInstructionsPrompt":"\u003cstring>","supportConcurrentLogins":true,"sessionExpiryMinutes":123,"autoRetryOnServiceDown":true,"autoRetryDelayMinutes":2,"autoRetryMaxAttempts":2}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d5e0b4f4-0d5e-4dd6-a4cd-4fe0fe28c346":{"description":"Login created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the login","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"organizationId":{"type":"string","description":"ID of the organization that owns this login.","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string"},"name":{"type":"string","description":"Name of the login","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"authenticationUrl":{"type":"string","description":"URL of the authentication page","isRequired":true,"uniqueKey":"authenticationUrl","typeLabel":"string"},"homeUrl":{"type":"string","description":"URL of the home page","isRequired":true,"uniqueKey":"homeUrl","typeLabel":"string"},"iconUrl":{"oneOf":[{"type":"string","description":"Icon URL or data URL for the login logo. Null if no custom logo is set.","isRequired":true,"uniqueKey":"iconUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Icon URL or data URL for the login logo. Null if no custom logo is set.","isRequired":true,"uniqueKey":"iconUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"iconUrl","typeLabel":"string | null"},"loginConfiguration":{"type":"object","properties":{"username":{"type":"string","description":"Username for authentication","uniqueKey":"loginConfiguration.username","typeLabel":"string"},"twoFactorAuthConfiguration":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","enum":["Email","SMS","TOTP"],"description":"Method used for 2FA verification","isRequired":true,"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.method","typeLabel":"enum\u003cstring>"},"alwaysRequired":{"type":"boolean","description":"Whether 2FA is always required, if it is not, the workflow will make a determination based upon the text displayed on the site.","isRequired":true,"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.alwaysRequired","typeLabel":"boolean"},"twoFactorAuthEmail":{"type":"string","description":"The email which the 2FA codes will be sent to, which our system will use to associate to the created login. Required when method is Email.","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0.twoFactorAuthEmail","typeLabel":"string"}},"required":["method","alwaysRequired"],"description":"Configuration for two-factor authentication","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"method":{"type":"string","enum":["Email","SMS","TOTP"],"description":"Method used for 2FA verification"},"alwaysRequired":{"type":"boolean","description":"Whether 2FA is always required, if it is not, the workflow will make a determination based upon the text displayed on the site."},"twoFactorAuthEmail":{"type":"string","description":"The email which the 2FA codes will be sent to, which our system will use to associate to the created login. Required when method is Email."}},"required":["method","alwaysRequired"],"description":"Configuration for two-factor authentication","uniqueKey":"loginConfiguration.twoFactorAuthConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"loginConfiguration.twoFactorAuthConfiguration","typeLabel":"object | null"},"additionalCredentials":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key for the additional credential","isRequired":true,"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the additional credential","isRequired":true,"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].value","typeLabel":"string"},"id":{"type":"string","description":"Unique identifier for the additional credential","uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX].id","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"loginConfiguration.additionalCredentials.items.[INDEX]","typeLabel":"object"},"description":"Additional key-value credentials","uniqueKey":"loginConfiguration.additionalCredentials","typeLabel":"object[]"}},"description":"Values for fields required to complete authentication. Sensitive credentials are excluded for security.","isRequired":true,"uniqueKey":"loginConfiguration","typeLabel":"object"},"createdAt":{"type":"string","description":"Timestamp when the login was created","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Timestamp when the login was last updated","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"persistSession":{"type":"boolean","default":true,"description":"Whether to persist the session after authentication","isRequired":true,"uniqueKey":"persistSession","typeLabel":"boolean"},"isManualAuthentication":{"type":"boolean","default":false,"description":"Whether this login requires manual authentication","isRequired":true,"uniqueKey":"isManualAuthentication","typeLabel":"boolean"},"supportConcurrentLogins":{"type":"boolean","default":true,"description":"Whether to allow concurrent logins using this login. When false, a lock is acquired before login to prevent simultaneous sessions.","isRequired":true,"uniqueKey":"supportConcurrentLogins","typeLabel":"boolean"},"autoRetryOnServiceDown":{"type":"boolean","default":false,"description":"Whether to automatically retry scheduled executions when the target service appears to be down.","isRequired":true,"uniqueKey":"autoRetryOnServiceDown","typeLabel":"boolean"},"autoRetryDelayMinutes":{"type":"integer","default":30,"description":"Number of minutes to wait before retrying when service down is detected.","isRequired":true,"uniqueKey":"autoRetryDelayMinutes","typeLabel":"integer"},"autoRetryMaxAttempts":{"type":"integer","default":3,"description":"Maximum number of service-down retry attempts before giving up.","isRequired":true,"uniqueKey":"autoRetryMaxAttempts","typeLabel":"integer"},"latestAuthentication":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["Completed","Failed"],"isRequired":true,"uniqueKey":"latestAuthentication.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"latestAuthentication.oneOf.0.updatedAt","typeLabel":"string"}},"required":["status","updatedAt"],"uniqueKey":"latestAuthentication.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["Completed","Failed"]},"updatedAt":{"type":"string"}},"required":["status","updatedAt"],"uniqueKey":"latestAuthentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"latestAuthentication","typeLabel":"object | null"},"lastUsedBy":{"oneOf":[{"type":"object","properties":{"threadId":{"type":"string","isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.threadId","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.name","typeLabel":"string | null"},"operatorName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.operatorName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.operatorName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lastUsedBy.oneOf.0.operatorName","typeLabel":"string | null"}},"required":["threadId","name","operatorName"],"uniqueKey":"lastUsedBy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"threadId":{"type":"string"},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"operatorName":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["threadId","name","operatorName"],"uniqueKey":"lastUsedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastUsedBy","typeLabel":"object | null"},"usedBy":{"type":"array","items":{"type":"string","uniqueKey":"usedBy.items.[INDEX]","typeLabel":"string"},"description":"Names of the operators whose sessions used this login.","uniqueKey":"usedBy","typeLabel":"string[]"},"useLLMLoginDetection":{"type":"boolean","description":"Whether to use LLM-powered login detection. If false, uses URL-based detection instead.","uniqueKey":"useLLMLoginDetection","typeLabel":"boolean"},"loginDetectionPrompt":{"type":"string","description":"Custom prompt to use for LLM-based login detection. Describes what the logged-out experience looks like.","uniqueKey":"loginDetectionPrompt","typeLabel":"string"},"loginInstructionsPrompt":{"type":"string","description":"Custom instructions for the login agent. Provides guidance on how to complete the login flow for this specific site.","uniqueKey":"loginInstructionsPrompt","typeLabel":"string"},"sessionExpiryMinutes":{"oneOf":[{"type":"integer","maximum":2147483647,"description":"Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.","uniqueKey":"sessionExpiryMinutes.oneOf.0","typeLabel":"integer"},{"type":"null","maximum":2147483647,"description":"Minutes after a fresh login before its saved session stops being reused and the next run logs in again. Values below 30 are saved as 30. Null or omitted keeps reusing the saved session.","uniqueKey":"sessionExpiryMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionExpiryMinutes","typeLabel":"integer | null"}},"required":["id","organizationId","name","authenticationUrl","homeUrl","iconUrl","loginConfiguration","createdAt","updatedAt","persistSession","isManualAuthentication","supportConcurrentLogins","autoRetryOnServiceDown","autoRetryDelayMinutes","autoRetryMaxAttempts"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","organizationId":"\u003cstring>","name":"\u003cstring>","authenticationUrl":"\u003cstring>","homeUrl":"\u003cstring>","iconUrl":"\u003cstring>","loginConfiguration":{"username":"\u003cstring>","twoFactorAuthConfiguration":{"method":"Email","alwaysRequired":true,"twoFactorAuthEmail":"\u003cstring>"},"additionalCredentials":[{"key":"\u003cstring>","value":"\u003cstring>","id":"\u003cstring>"}]},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","persistSession":true,"isManualAuthentication":false,"supportConcurrentLogins":true,"autoRetryOnServiceDown":false,"autoRetryDelayMinutes":30,"autoRetryMaxAttempts":3,"latestAuthentication":{"status":"Completed","updatedAt":"\u003cstring>"},"lastUsedBy":{"threadId":"\u003cstring>","name":"\u003cstring>","operatorName":"\u003cstring>"},"usedBy":["\u003cstring>"],"useLLMLoginDetection":true,"loginDetectionPrompt":"\u003cstring>","loginInstructionsPrompt":"\u003cstring>","sessionExpiryMinutes":123}}},"exampleType":"generated"}},"exampleType":"generated"},"4e38e10d-a613-45d9-bd5a-677c43c6a8ca":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"9a402b36-c691-4e99-be7b-195e4566257b":{"url":"https://api.kaizenautomation.com","description":"Production server"}}},"originalFileLocation":"openapi.json"},"subdomain":"kaizenautomation","siteName":"Kaizen","title":"Create a login - Kaizen","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T08:02:33.113Z","originalFileLocation":"api-reference/logins/create-a-login.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=\"Creates a new login with required credentials\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kaizen\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_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/kaizenautomation/4hld95ZurNmtSFvg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a login - Kaizen\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new login with required credentials\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kaizen\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kaizenautomation.mintlify.site/_mintlify/api/og/v2?division=Logins\u0026amp;title=Create+a+login\u0026amp;description=Creates+a+new+login+with+required+credentials\u0026amp;theme=f37fa918ce4d41d4e022ce89\u0026amp;signature=17273eb60999e54aa1bc3cfb6b0ecfbd8a06e735af337e1467caaac1369c5e7d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a login - Kaizen\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new login with required credentials\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kaizenautomation.mintlify.site/_mintlify/api/og/v2?division=Logins\u0026amp;title=Create+a+login\u0026amp;description=Creates+a+new+login+with+required+credentials\u0026amp;theme=f37fa918ce4d41d4e022ce89\u0026amp;signature=17273eb60999e54aa1bc3cfb6b0ecfbd8a06e735af337e1467caaac1369c5e7d\">\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/kaizenautomation/4hld95ZurNmtSFvg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kaizen\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ffcc00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/logins/create-a-login.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kaizenautomation.com/#organization\",\"name\":\"Kaizen\",\"url\":\"https://docs.kaizenautomation.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kaizenautomation/Wx0TyKIp-iSVxHVM/logo/light.svg?fit=max\u0026auto=format\u0026n=Wx0TyKIp-iSVxHVM\u0026q=85\u0026s=f3e4d00ffe0f3d46f58a68a433349b22\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kaizenautomation.com#website\",\"name\":\"Kaizen\",\"url\":\"https://docs.kaizenautomation.com\",\"publisher\":{\"@id\":\"https://docs.kaizenautomation.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login#webpage\",\"url\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login\",\"name\":\"Create a login\",\"description\":\"Creates a new login with required credentials\",\"dateModified\":\"2026-11-04T08:02:33.113Z\",\"isPartOf\":{\"@id\":\"https://docs.kaizenautomation.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Kaizen\",\"item\":\"https://docs.kaizenautomation.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a login\",\"item\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login#apireference\",\"headline\":\"Create a login\",\"name\":\"Create a login\",\"description\":\"Creates a new login with required credentials\",\"url\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kaizenautomation.com/api-reference/logins/create-a-login#webpage\"},\"dateModified\":\"2026-11-04T08:02:33.113Z\",\"publisher\":{\"@id\":\"https://docs.kaizenautomation.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kaizenautomation.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kaizen\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kaizen\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/logins/create-a-login.md","siteName":"Kaizen","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"openapi":"post /authentication/submitTwoFactorAuthCode","title":"Submit 2FA code","href":"/api-reference/authentication/submit-2fa-code"},{"openapi":"post /authentication/completeLogin","title":"Complete login authentication","description":"Completes login authentication using browser context login info external ID by saving browser cookies and updating authentication status","href":"/api-reference/authentication/complete-login-authentication"}]},{"group":"Logins","pages":[{"openapi":"post /logins/create","title":"Create a login","href":"/api-reference/logins/create-a-login"},{"openapi":"post /logins/update","title":"Update a login","description":"Updates an existing login with optional credentials","href":"/api-reference/logins/update-a-login"},{"openapi":"post /logins/delete","title":"Delete a login","href":"/api-reference/logins/delete-a-login"},{"openapi":"post /logins/list","title":"List logins","href":"/api-reference/logins/list-logins"},{"openapi":"post /logins/getPassword","title":"Get login password","href":"/api-reference/logins/get-login-password"}]},{"group":"Executions","pages":[{"openapi":"post /executions/list","title":"List executions","href":"/api-reference/executions/list-executions"},{"openapi":"post /executions/get","title":"Get execution","href":"/api-reference/executions/get-execution"},{"openapi":"post /executions/retry","title":"Retry execution","href":"/api-reference/executions/retry-execution"}]},{"group":"Browser Sessions","pages":[{"openapi":"post /browsers/getSessionRecording","title":"Get browser session recording","href":"/api-reference/browser-sessions/get-browser-session-recording"}]},{"group":"Workflows","pages":[{"openapi":"post /workflows/execute","title":"Execute a workflow","href":"/api-reference/workflows/execute-a-workflow"},{"openapi":"post /workflows/executeSync","title":"Execute a workflow synchronously","href":"/api-reference/workflows/execute-a-workflow-synchronously"},{"openapi":"post /workflows/update","title":"Update a workflow","href":"/api-reference/workflows/update-a-workflow"},{"openapi":"post /workflows/executeBatch","title":"Execute multiple workflows in a batch","href":"/api-reference/workflows/execute-multiple-workflows-in-a-batch"}]},{"group":"Instructor","pages":[{"openapi":"post /instructor/executions/runBlock","title":"Run single block","href":"/api-reference/instructor/run-single-block"}]},{"group":"Files","pages":[{"openapi":"post /files/get","title":"Get file","href":"/api-reference/files/get-file"},{"openapi":"post /files/create","title":"Create a file","href":"/api-reference/files/create-a-file"}]},{"group":"Agents","pages":[{"openapi":"post /agents/session/getFileArchiveUrl","title":"Get session archive download URL","href":"/api-reference/agents/get-session-archive-download-url"},{"openapi":"post /agents/execute","title":"Execute agent","href":"/api-reference/agents/execute-agent"},{"openapi":"post /agents/sessions/get","title":"Get session","href":"/api-reference/agents/get-session"},{"openapi":"post /agents/sessions/pause","title":"Pause session","href":"/api-reference/agents/pause-session"},{"openapi":"post /agents/session/messages/list","title":"List agent messages","href":"/api-reference/agents/list-agent-messages"}]},{"group":"Webhooks","pages":[{"openapi":"webhook events","title":"Event","href":"/api-reference/webhooks/event"}]}]}]},"basePath":"","title":"Create a login - Kaizen","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}