KAkaizenautomation
Logins

Create a login

Changed on

Creates a new login with required credentials

post/logins/create

Request

  • Base URL
    https://api.kaizenautomation.com
  • Auth
    none declared

Request body

namestring required

Name of the login for identification

authenticationUrlstring required

URL of the authentication page

homeUrlstring required

URL of the home page of the domain

iconUrlstring

Optional icon URL or data URL for the login logo.

persistSessionboolean

Whether to persist the session after authentication

isManualAuthenticationboolean

Whether this login requires manual authentication

useLLMLoginDetectionboolean

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

loginDetectionPromptstring

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

loginInstructionsPromptstring

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

supportConcurrentLoginsboolean

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

sessionExpiryMinutesinteger nullable

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.

autoRetryOnServiceDownboolean

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

autoRetryDelayMinutesinteger

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

autoRetryMaxAttemptsinteger

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

Response

Login created successfully

usedBystring[]

Names of the operators whose sessions used this login.

idstring required

Unique identifier for the login

organizationIdstring required

ID of the organization that owns this login.

namestring required

Name of the login

authenticationUrlstring required

URL of the authentication page

homeUrlstring required

URL of the home page

iconUrlstring nullable required

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

createdAtstring required

Timestamp when the login was created

updatedAtstring required

Timestamp when the login was last updated

persistSessionboolean required

Whether to persist the session after authentication

isManualAuthenticationboolean required

Whether this login requires manual authentication

useLLMLoginDetectionboolean

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

loginDetectionPromptstring

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

loginInstructionsPromptstring

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

supportConcurrentLoginsboolean required

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

sessionExpiryMinutesinteger nullable

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.

autoRetryOnServiceDownboolean required

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

autoRetryDelayMinutesinteger required

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

autoRetryMaxAttemptsinteger required

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

Changes

  • f4147307ffb2Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 5df5aa328ac3Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property