Update a login

curl --request POST \ --url https://api.kaizenautomation.com/logins/update \ --header 'Content-Type: application/json' \ --data ' { "id": "<string>", "name": "<string>", "authenticationUrl": "<string>", "homeUrl": "<string>", "loginConfiguration": { "username": "<string>", "twoFactorAuthConfiguration": { "alwaysRequired": true, "twoFactorAuthEmail": "<string>", "totpSecretKey": "<string>" }, "additionalCredentials": [ { "key": "<string>", "value": "<string>", "id": "<string>" } ], "password": "<string>" }, "iconUrl": "<string>", "description": "<string>", "persistSession": true, "isManualAuthentication": true, "useLLMLoginDetection": true, "loginDetectionPrompt": "<string>", "loginInstructionsPrompt": "<string>", "supportConcurrentLogins": true, "supportsAgentConcurrency": true, "downtimeWindows": [ { "dayOfWeek": 3, "startTime": "<string>", "endTime": "<string>", "timezone": "<string>" } ], "autoRetryOnServiceDown": true, "autoRetryDelayMinutes": 2, "autoRetryMaxAttempts": 2 } '

{ "id": "<string>", "organizationId": "<string>", "name": "<string>", "authenticationUrl": "<string>", "homeUrl": "<string>", "iconUrl": "<string>", "description": "<string>", "loginConfiguration": { "username": "<string>", "twoFactorAuthConfiguration": { "alwaysRequired": true, "twoFactorAuthEmail": "<string>" }, "additionalCredentials": [ { "key": "<string>", "value": "<string>", "id": "<string>" } ] }, "createdAt": "<string>", "updatedAt": "<string>", "persistSession": true, "isManualAuthentication": false, "supportConcurrentLogins": true, "supportsAgentConcurrency": false, "downtimeWindows": [], "autoRetryOnServiceDown": false, "autoRetryDelayMinutes": 30, "autoRetryMaxAttempts": 3, "useLLMLoginDetection": true, "loginDetectionPrompt": "<string>", "loginInstructionsPrompt": "<string>" }

Body

application/json

string

required

ID of the login to update

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

Values for fields required to complete authentication. Sensitive credentials are optional for upsert operations.

Show child attributes

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

Whether this login requires manual authentication

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

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

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.

downtimeWindows

object[]

Recurring weekly downtime windows when the target service is known to be unavailable. Scheduled executions will be skipped during these windows.

Show child attributes

autoRetryOnServiceDown

boolean

Whether to automatically retry scheduled executions when the target service appears to be down.

autoRetryDelayMinutes

integer

Number of minutes to wait before retrying when service down is detected. Defaults to 30.

Required range: x >= 1

autoRetryMaxAttempts

integer

Maximum number of service-down retry attempts before giving up. Defaults to 3.

Required range: x >= 1

Response

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.

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

Show child attributes

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.

downtimeWindows

object[]

required

Recurring weekly downtime windows when the target service is known to be unavailable.

Show child attributes

autoRetryOnServiceDown

boolean

default:false

required

Whether to automatically retry scheduled executions when the target service appears to be down.

autoRetryDelayMinutes

integer

default:30

required

Number of minutes to wait before retrying when service down is detected.

autoRetryMaxAttempts

integer

default:3

required

Maximum number of service-down retry attempts before giving up.

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

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

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