Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Managed Auth

Create auth connection

Creates an auth connection for a profile and domain combination. If the provided profile_name does not exist, it is created automatically. Returns 409 Conflict if an auth connection already exists for the given profile and domain.

post/auth/connections

Request body

domainstring required

Domain for authentication

profile_namestring required

Name of the profile to manage authentication for. If the profile does not exist, it is created automatically.

login_urlstring uri

Optional login page URL to skip discovery

allowed_domainsstring[]

Additional domains 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
health_check_intervalinteger

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). The minimum depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour).

health_checksboolean

Whether to enable periodic health checks. 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). Defaults to true.

auto_reauthboolean

Whether to permit automatic re-authentication when a scheduled health check detects an expired session. 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 are marked as NEEDS_AUTH instead of attempting re-auth. Defaults to true.

save_credentialsboolean

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

record_sessionboolean

Whether to record browser sessions for this connection by default. Useful for debugging. Can be overridden per-login. Defaults to false.

Example request

{
  "domain": "netflix.com",
  "profile_name": "user-123",
  "login_url": "https://netflix.com/login",
  "credential": {
    "name": "my-netflix-creds",
    "provider": "my-1p",
    "path": "Personal/Netflix",
    "auto": true
  },
  "allowed_domains": [
    "login.netflix.com",
    "auth.netflix.com"
  ],
  "health_check_interval": 3600,
  "health_checks": true,
  "auto_reauth": true,
  "save_credentials": true
}

Response

Auth connection created

idstring required

Unique identifier for the auth connection

profile_namestring required

Name of the profile associated with this auth connection

domainstring required

Target domain for authentication

status'AUTHENTICATED' | 'NEEDS_AUTH' required

Current authentication status of the managed profile

last_auth_check_atstring 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.

last_auth_atstring date-time

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.

can_reauthboolean

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.

can_reauth_reason'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'

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
proxy_idstring

ID of the proxy associated with this connection, if any.

allowed_domainsstring[]

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
login_urlstring uri

Optional login page URL to skip discovery

post_login_urlstring uri

URL where the browser landed after successful login

flow_status'IN_PROGRESS' | 'SUCCESS' | 'FAILED' | 'EXPIRED' | 'CANCELED' nullable

Current flow status (null when no flow in progress)

flow_step'DISCOVERING' | 'AWAITING_INPUT' | 'AWAITING_EXTERNAL_ACTION' | 'SUBMITTING' | 'COMPLETED' nullable

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

flow_type'LOGIN' | 'REAUTH' nullable

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

flow_expires_atstring date-time nullable

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.

external_action_messagestring nullable

Instructions for external action (present when flow_step=awaiting_external_action)

website_errorstring nullable

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

sso_providerstring nullable

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

error_messagestring nullable

Error message (present when flow_status=failed)

error_codestring nullable

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

hosted_urlstring uri nullable

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

live_view_urlstring uri nullable

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

browser_session_idstring nullable

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.

health_check_intervalinteger nullable

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). The minimum depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour).

health_checksboolean

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.

auto_reauthboolean

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.

save_credentialsboolean required

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

record_sessionboolean required

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

Example response

{
  "id": "ma_abc123xyz",
  "profile_name": "my-netflix-profile",
  "domain": "netflix.com",
  "status": "AUTHENTICATED",
  "last_auth_check_at": "2025-01-15T10:30:00Z",
  "last_auth_at": "2025-01-15T10:30:00Z",
  "credential": {
    "name": "my-netflix-creds",
    "provider": "my-1p",
    "path": "Personal/Netflix",
    "auto": true
  },
  "can_reauth": true,
  "can_reauth_reason": "has_credential",
  "allowed_domains": [
    "login.netflix.com",
    "auth.netflix.com"
  ],
  "login_url": "https://example.com/login",
  "post_login_url": "https://www.netflix.com/browse",
  "flow_status": "IN_PROGRESS",
  "flow_step": "AWAITING_INPUT",
  "flow_type": "LOGIN",
  "flow_expires_at": "2025-11-05T20:00:00Z",
  "fields": [
    {
      "id": "field_email",
      "ref": "email",
      "type": "identifier",
      "label": "Email address",
      "observed_selector": "input[name=\"identifier\"]"
    }
  ],
  "choices": [
    {
      "id": "google",
      "type": "sso_provider",
      "label": "Google",
      "observed_selector": "button:has-text(\"Google\")"
    }
  ],
  "discovered_fields": [
    {
      "name": "email",
      "type": "email",
      "label": "Email address",
      "placeholder": "you@example.com",
      "required": true,
      "selector": "input#email",
      "linked_mfa_type": "sms",
      "hint": "Enter the phone ending in (***) ***-**92"
    }
  ],
  "mfa_options": [
    {
      "type": "sms",
      "label": "Text me a code",
      "target": "***-***-5678",
      "description": "We'll send a 6-digit code to your phone"
    }
  ],
  "sign_in_options": [
    {
      "id": "work-account",
      "label": "Work Account (user@company.com)",
      "description": "user@company.com"
    }
  ],
  "pending_sso_buttons": [
    {
      "selector": "xpath=//button[contains(text(), 'Continue with Google')]",
      "provider": "google",
      "label": "Continue with Google"
    }
  ],
  "external_action_message": "Tap 'Yes' on the Google prompt on your phone",
  "sso_provider": "google",
  "error_message": "Invalid password",
  "hosted_url": "https://auth.kernel.com/login/abc123xyz",
  "live_view_url": "https://live.kernel.com/abc123xyz",
  "browser_session_id": "bs_abc123xyz",
  "health_check_interval": 3600,
  "health_checks": true,
  "auto_reauth": true,
  "save_credentials": true
}