Skip to main content
POST
/
logins
/
create
Create a login
curl --request POST \
  --url https://api.kaizenautomation.com/logins/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "authenticationUrl": "<string>",
  "homeUrl": "<string>",
  "loginConfiguration": {
    "username": "<string>",
    "twoFactorAuthConfiguration": {
      "method": "Email",
      "alwaysRequired": true,
      "twoFactorAuthEmail": "<string>",
      "totpSecretKey": "<string>"
    },
    "additionalCredentials": [
      {
        "key": "<string>",
        "value": "<string>",
        "id": "<string>"
      }
    ],
    "password": "<string>",
    "apiKey": "<string>",
    "bearerToken": "<string>"
  },
  "iconUrl": "<string>",
  "description": "<string>",
  "persistSession": true,
  "isManualAuthentication": false,
  "useLLMLoginDetection": true,
  "loginDetectionPrompt": "<string>",
  "loginInstructionsPrompt": "<string>",
  "supportConcurrentLogins": true,
  "supportsAgentConcurrency": true
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "authenticationUrl": "<string>",
  "homeUrl": "<string>",
  "iconUrl": "<string>",
  "description": "<string>",
  "loginConfiguration": {
    "username": "<string>",
    "twoFactorAuthConfiguration": {
      "method": "Email",
      "alwaysRequired": true,
      "twoFactorAuthEmail": "<string>"
    },
    "additionalCredentials": [
      {
        "key": "<string>",
        "value": "<string>",
        "id": "<string>"
      }
    ]
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "persistSession": true,
  "isManualAuthentication": false,
  "supportConcurrentLogins": true,
  "supportsAgentConcurrency": false,
  "useLLMLoginDetection": true,
  "loginDetectionPrompt": "<string>",
  "loginInstructionsPrompt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kaizenautomation.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Login creation parameters

​
name
string
required

Name of the login for identification

Minimum string length: 1
​
authenticationUrl
string
required

URL of the authentication page

​
homeUrl
string
required

URL of the home page of the domain

​
loginConfiguration
object
required

Values for fields required to complete authentication, including sensitive credentials.

​
iconUrl
string

Optional icon URL or data URL for the login logo.

Maximum string length: 700000
​
description
string

Optional description/subheading for the login (e.g., "HR portal for employee records")

​
persistSession
boolean

Whether to persist the session after authentication

​
isManualAuthentication
boolean
default:false

Whether this login requires manual authentication

​
useLLMLoginDetection
boolean

Whether to use LLM-powered login detection. If false, uses URL-based detection instead.

​
loginDetectionPrompt
string

Custom prompt to use for LLM-based login detection. Describes what the logged-out experience looks like.

​
loginInstructionsPrompt
string

Custom instructions for the login agent. Provides guidance on how to complete the login flow for this specific site.

​
supportConcurrentLogins
boolean

Whether to allow concurrent logins using this login. When false, a lock is acquired before login to prevent simultaneous sessions.

​
supportsAgentConcurrency
boolean

Whether this login supports concurrent usage by multiple agents. When false (default), only one agent can use this login at a time.

Response

Login created successfully

​
id
string
required

Unique identifier for the login

​
organizationId
string
required

ID of the organization that owns this login.

​
name
string
required

Name of the login

​
authenticationUrl
string
required

URL of the authentication page

​
homeUrl
string
required

URL of the home page

​
iconUrl
string | null
required

Icon URL or data URL for the login logo. Null if no custom logo is set.

​
description
string | null
required

Optional description/subheading for the login. Null if no description is set.

​
loginConfiguration
object
required

Values for fields required to complete authentication. Sensitive credentials are excluded for security.

​
createdAt
string
required

Timestamp when the login was created

​
updatedAt
string
required

Timestamp when the login was last updated

​
persistSession
boolean
default:true
required

Whether to persist the session after authentication

​
isManualAuthentication
boolean
default:false
required

Whether this login requires manual authentication

​
supportConcurrentLogins
boolean
default:true
required

Whether to allow concurrent logins using this login. When false, a lock is acquired before login to prevent simultaneous sessions.

​
supportsAgentConcurrency
boolean
default:false
required

Whether this login supports concurrent usage by multiple agents. When false (default), only one agent can use this login at a time.

​
useLLMLoginDetection
boolean

Whether to use LLM-powered login detection. If false, uses URL-based detection instead.

​
loginDetectionPrompt
string

Custom prompt to use for LLM-based login detection. Describes what the logged-out experience looks like.

​
loginInstructionsPrompt
string

Custom instructions for the login agent. Provides guidance on how to complete the login flow for this specific site.