Skip to main content
PATCH
Update auth connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Auth connection ID

Body

application/json

Request to update an auth connection's configuration

allowed_domains
string[]

Additional domains valid for this auth flow (replaces existing list)

Example:
auto_reauth
boolean

Whether automatic re-authentication is permitted for this connection. This is an opt-in flag only — it does not check whether re-auth is actually feasible. Even when true, re-auth only runs when the system has what it needs to perform it (for example, saved credentials for the required login fields), and only after a scheduled health check detects an expired session — so this flag has no effect when health_checks is false. When false, expired sessions detected by a health check are marked as NEEDS_AUTH instead of attempting re-auth.

Example:

true

browser
object

Browser configuration updates for future login, reauthentication, and health-check sessions. Omitted properties remain unchanged.

browser_telemetry
object | null
deprecated

Deprecated. Use browser.telemetry. Retained during migration for existing clients.

credential
object

Reference to credentials for the auth connection. Use one of:

  • { name } for Kernel credentials
  • { provider, path } for external provider item
  • { provider, auto: true } for external provider domain lookup
health_check_interval
integer

Interval in seconds between automatic health checks

Required range: 300 <= x <= 86400
Example:

3600

health_checks
boolean

Whether periodic health checks are enabled. When set to false, the system will not automatically verify authentication status, and auto_reauth has no effect on the automatic flow (since re-auth is only triggered by a failed scheduled health check).

Example:

true

login_url
string<uri>

Login page URL. Set to empty string to clear.

Example:

"https://netflix.com/login"

proxy
object
deprecated

Deprecated. Use browser.proxy. Retained during migration for existing clients.

record_session
boolean

Whether to record browser sessions for this connection by default

Example:

false

save_credentials
boolean

Whether to save credentials after every successful login

Example:

true

Response

Auth connection updated successfully

Managed authentication that keeps a profile logged into a specific domain. Flow fields (flow_status, flow_step, discovered_fields, mfa_options) reflect the most recent login flow and are null when no flow has been initiated.

domain
string
required

Target domain for authentication

Example:

"netflix.com"

id
string
required

Unique identifier for the auth connection

Example:

"ma_abc123xyz"

profile_name
string
required

Name of the profile associated with this auth connection

Example:

"my-netflix-profile"

record_session
boolean
required

Whether to record browser session replays for this connection by default. Useful for debugging login flows. Can be overridden per-login.

Example:

false

save_credentials
boolean
required

Whether credentials are saved after every successful login. One-time codes (TOTP, SMS, etc.) are not saved.

Example:

true

status
enum<string>
required

Current authentication status of the managed profile

Available options:
AUTHENTICATED,
NEEDS_AUTH
Example:

"AUTHENTICATED"

allowed_domains
string[]

Additional domains that are valid for this auth flow (besides the primary domain). Useful when login pages redirect to different domains.

The following SSO/OAuth provider domains are automatically allowed by default and do not need to be specified:

  • Google: accounts.google.com
  • Microsoft/Azure AD: login.microsoftonline.com, login.live.com
  • Okta: *.okta.com, *.oktapreview.com
  • Auth0: *.auth0.com, *.us.auth0.com, *.eu.auth0.com, *.au.auth0.com
  • Apple: appleid.apple.com
  • GitHub: github.com
  • Facebook/Meta: www.facebook.com
  • LinkedIn: www.linkedin.com
  • Amazon Cognito: *.amazoncognito.com
  • OneLogin: *.onelogin.com
  • Ping Identity: *.pingone.com, *.pingidentity.com
Example:
auto_reauth
boolean

Whether automatic re-authentication is permitted for this connection. This is an opt-in flag only — it does not check whether re-auth is actually feasible. Even when true, re-auth only runs when the system has what it needs to perform it (for example, saved credentials for the required login fields), and only after a scheduled health check detects an expired session — so this flag has no effect when health_checks is false. When false, expired sessions detected by a health check are marked as NEEDS_AUTH instead of attempting re-auth.

Example:

true

browser
object

Default browser configuration for login, reauthentication, and health-check sessions.

browser_session_id
string | null

ID of the underlying browser session driving the current flow (present when flow in progress). Use this to inspect or terminate the browser session via the /browsers API.

Example:

"bs_abc123xyz"

browser_telemetry
object | null
deprecated

Deprecated. Use browser.telemetry. Retained during migration for existing clients.

can_reauth
boolean

Whether Kernel can automatically re-authenticate this connection when the session expires. Requires a prior successful login plus either a Kernel credential or an external credential reference. See can_reauth_reason for the specific outcome.

Example:

true

can_reauth_reason
enum<string>

Machine-readable reason for the current value of can_reauth. Affirmative values (re-auth is possible):

  • external_credential — an external credential provider is attached
  • cua_has_credential — CUA flow with a stored credential
  • has_credential — Kernel credential is attached (optimistic; plan viability not checked)
  • viable_plans_found — at least one stored login plan can be replayed
  • no_requirements_recorded — no recorded credential requirements to fail against
  • requirements_satisfiable — recorded requirements can be met by the attached credential

Negative values (a human must complete the login flow):

  • no_prior_successful_login — connection has never completed a successful login
  • no_credential — no Kernel or external credential attached
  • no_viable_plans — credential attached but no replayable login plan exists yet
  • viable_plans_require_external_action — stored plans need an external step (email link, push, etc.)
  • requires_external_action — recorded requirements include an external step
  • requires_totp_without_secret — flow needs a TOTP code but no TOTP secret is stored
  • requires_sms_code — flow needs an SMS code that cannot be received automatically
  • requires_email_code — flow needs an email code that cannot be received automatically
  • requires_customer_input — flow needs another field or choice that is unavailable during unattended re-authentication
Available options:
external_credential,
cua_has_credential,
has_credential,
viable_plans_found,
no_requirements_recorded,
requirements_satisfiable,
no_prior_successful_login,
no_credential,
no_viable_plans,
viable_plans_require_external_action,
requires_external_action,
requires_totp_without_secret,
requires_sms_code,
requires_email_code,
requires_customer_input
Example:

"has_credential"

choices
object[] | null

Canonical choices awaiting selection. Prefer this over pending_sso_buttons, mfa_options, and sign_in_options when present.

credential
object

Reference to credentials for the auth connection. Use one of:

  • { name } for Kernel credentials
  • { provider, path } for external provider item
  • { provider, auto: true } for external provider domain lookup
discovered_fields
object[] | null

Fields awaiting input (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)

error_code
string | null

Machine-readable error code (present when flow_status=failed)

error_message
string | null

Error message (present when flow_status=failed)

Example:

"Invalid password"

external_action_message
string | null

Instructions for external action (present when flow_step=awaiting_external_action)

Example:

"Tap 'Yes' on the Google prompt on your phone"

fields
object[] | null

Canonical fields awaiting input. Prefer this over discovered_fields when present.

flow_expires_at
string<date-time> | null

When the current flow expires (null when no flow in progress). A flow past this timestamp is no longer valid and its flow_status will be EXPIRED. Clients may start a new login to supersede a stale IN_PROGRESS flow past this timestamp.

Example:

"2025-11-05T20:00:00Z"

flow_status
enum<string> | null

Current flow status (null when no flow in progress)

Available options:
IN_PROGRESS,
SUCCESS,
FAILED,
EXPIRED,
CANCELED
Example:

"IN_PROGRESS"

flow_step
enum<string> | null

Current step in the flow (null when no flow in progress)

Available options:
DISCOVERING,
AWAITING_INPUT,
AWAITING_EXTERNAL_ACTION,
SUBMITTING,
COMPLETED
Example:

"AWAITING_INPUT"

flow_type
enum<string> | null

Type of the current flow (null when no flow in progress)

Available options:
LOGIN,
REAUTH
Example:

"LOGIN"

health_check_interval
integer | null

Interval in seconds between automatic health checks. When set, the system periodically verifies the authentication status and triggers re-authentication if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour) or your plan minimum, whichever is larger. The minimum depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour), Free: 21600 (6 hours).

Required range: 300 <= x <= 86400
Example:

3600

health_checks
boolean

Whether periodic health checks are enabled for this connection. When false, the system will not automatically verify authentication status, and auto_reauth has no effect on the automatic flow (since re-auth is only triggered by a failed scheduled health check). Manually triggering a health check via the API still works regardless of this setting.

Example:

true

hosted_url
string<uri> | null

URL to redirect user to for hosted login (present when flow in progress)

Example:

"https://auth.kernel.com/login/abc123xyz"

last_auth_at
string<date-time>
deprecated

Deprecated alias for last_auth_check_at. Despite the name, this is the last health-check timestamp, not the last successful authentication. Use last_auth_check_at instead.

Example:

"2025-01-15T10:30:00Z"

last_auth_check_at
string<date-time>

When the most recent auth health check ran for this connection, regardless of outcome. Updated on every health check and does not by itself indicate that the profile is currently authenticated - use status for that. May be newer than flow_expires_at when a flow is still in progress because health checks continue to run in parallel.

Example:

"2025-01-15T10:30:00Z"

live_view_url
string<uri> | null

Browser live view URL for debugging (present when flow in progress)

Example:

"https://live.kernel.com/abc123xyz"

login_url
string<uri>

Optional login page URL to skip discovery

Example:

"https://example.com/login"

mfa_options
object[] | null

MFA method options (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)

pending_sso_buttons
object[] | null

SSO buttons available (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)

post_login_url
string<uri>

URL where the browser landed after successful login

Example:

"https://www.netflix.com/browse"

proxy_id
string
deprecated

Deprecated. Read browser.proxy instead. Retained during migration for existing clients.

sign_in_options
object[] | null

Non-MFA choices presented during the auth flow, such as account selection or org pickers (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions).

sso_provider
string | null

SSO provider being used (e.g., google, github, microsoft)

Example:

"google"

website_error
string | null

Visible error message from the website (e.g., 'Incorrect password'). Present when the website displays an error during login.