Skip to main content
POST
Update a login

Body

application/json

Login update parameters

id
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

loginConfiguration
object
required

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

iconUrl
string

Optional icon URL or data URL for the login logo.

Maximum string length: 700000
persistSession
boolean

Whether to persist the session after authentication

isManualAuthentication
boolean

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.

sessionExpiryMinutes
integer | null

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: -9007199254740991 <= x <= 2147483647
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: 1 <= x <= 9007199254740991
autoRetryMaxAttempts
integer

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

Required range: 1 <= x <= 9007199254740991

Response

Login updated 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.

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.

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.

Required range: -9007199254740991 <= x <= 9007199254740991
autoRetryMaxAttempts
integer
default:3
required

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

Required range: -9007199254740991 <= x <= 9007199254740991
latestAuthentication
object | null
lastUsedBy
object | null
usedBy
string[]

Names of the operators whose sessions used this login.

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.

sessionExpiryMinutes
integer | null

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: -9007199254740991 <= x <= 2147483647