---
title: "Get auth connection"
method: GET
path: "/auth/connections/{id}"
tags: ["Managed Auth"]
---

# Get auth connection

`GET /auth/connections/{id}`

Retrieve an auth connection by its ID. Includes current flow state if a login is in progress.

## Path parameters

- `id` string, required

## Response `200`

Auth connection details

- ManagedAuth — 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.
  - `id` string, required — Unique identifier for the auth connection
  - `profile_name` string, required — Name of the profile associated with this auth connection
  - `domain` string, required — Target domain for authentication
  - `status` 'AUTHENTICATED' | 'NEEDS_AUTH', required — Current authentication status of the managed profile
  - `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.
  - `last_auth_at` string, 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.
  - `credential` CredentialReference — 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
    - `name` string — Kernel credential name
    - `provider` string — External provider name (e.g., "my-1p")
    - `path` string — Provider-specific path (e.g., "VaultName/ItemName" for 1Password)
    - `auto` boolean — If true, lookup by domain from the specified provider
  - `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.
  - `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_id` string — ID of the proxy associated with this connection, if any.
  - `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
  - `login_url` string, uri — Optional login page URL to skip discovery
  - `post_login_url` string, 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_at` string, 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.
  - `fields` ManagedAuthField[], nullable — Canonical fields awaiting input. Prefer this over discovered_fields when present.
    - `id` string, required — Stable field identifier for canonical submit.
    - `ref` string, required — Credential reference name to store the submitted value under.
    - `type` 'identifier' | 'password' | 'code' | 'totp_code' | 'totp_secret' | 'text', required — Managed-auth field type.
    - `label` string — Human-readable label shown to the user.
    - `required` boolean — Whether this field is required.
    - `replace_existing` boolean — Whether the submitted value must replace an existing credential after explicit rejection.
    - `observed_selector` string, nullable — Selector for the visible field, when available.
  - `choices` ManagedAuthChoice[], nullable — Canonical choices awaiting selection. Prefer this over pending_sso_buttons, mfa_options, and sign_in_options when present.
    - `id` string, required — Stable choice identifier for canonical submit.
    - `type` 'mfa_method' | 'sso_provider' | 'sign_in_method' | 'auth_method' | 'identifier_method' | 'account' | 'other', required — Choice type.
    - `label` string, required — Human-readable choice label.
    - `description` string, nullable — Additional context for the choice.
    - `observed_selector` string, nullable — Selector for the visible choice, when available.
  - `discovered_fields` DiscoveredField[], nullable — Fields awaiting input (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)
    - `name` string, required — Field name
    - `type` 'text' | 'email' | 'password' | 'tel' | 'number' | 'url' | 'code' | 'totp', required — Field type
    - `label` string, required — Field label
    - `placeholder` string — Field placeholder
    - `required` boolean — Whether field is required
    - `selector` string, required — CSS selector for the field
    - `linked_mfa_type` 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | 'switch' — The MFA delivery method type. Includes 'password' for auth method selection pages and 'switch' for generic method-switcher links like "Use another method" that do not name a specific method.
    - `hint` string — Contextual help text near the field that tells the user what to enter (e.g., "Enter the phone ending in (***) ***-**92")
  - `mfa_options` MFAOption[], nullable — MFA method options (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)
    - `type` 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | 'switch', required — The MFA delivery method type. Includes 'password' for auth method selection pages and 'switch' for generic method-switcher links like "Use another method" that do not name a specific method.
    - `label` string, required — The visible option text
    - `target` string, nullable — The masked destination (phone/email) if shown
    - `description` string, nullable — Additional instructions from the site
  - `sign_in_options` SignInOption[], nullable — 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).
    - `id` string, required — Unique identifier for this option (used to submit selection back)
    - `label` string, required — Display text for the option
    - `description` string, nullable — Additional context such as email address or org name
  - `pending_sso_buttons` SSOButton[], nullable — SSO buttons available (present when flow_step=awaiting_input; may also be present with awaiting_external_action as fallback actions)
    - `selector` string, required — XPath selector for the button
    - `provider` string, required — Identity provider name
    - `label` string, required — Visible button text
  - `external_action_message` string, nullable — Instructions for external action (present when flow_step=awaiting_external_action)
  - `website_error` string, nullable — Visible error message from the website (e.g., 'Incorrect password'). Present when the website displays an error during login.
  - `sso_provider` string, nullable — SSO provider being used (e.g., google, github, microsoft)
  - `error_message` string, nullable — Error message (present when flow_status=failed)
  - `error_code` string, nullable — Machine-readable error code (present when flow_status=failed)
  - `hosted_url` string, uri, nullable — URL to redirect user to for hosted login (present when flow in progress)
  - `live_view_url` string, uri, nullable — Browser live view URL for debugging (present when flow in progress)
  - `browser_session_id` string, 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_interval` integer, 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_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.
  - `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.
  - `save_credentials` boolean, required — Whether credentials are saved after every successful login. One-time codes (TOTP, SMS, etc.) are not saved.
  - `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.
  - `browser_telemetry` BrowserTelemetryRequestConfig — Telemetry request configuration for a browser session.
    - `enabled` boolean — Request shortcut for browser telemetry capture. True enables capture; with no browser category settings it captures the default set (control, connection, system, captcha), and any browser category settings are layered onto that default set. On update, enabled=true resolves the config fresh from the default set plus any provided categories, replacing the session's current selection rather than merging onto it; omit enabled to merge categories onto the current selection instead. False stops capture on update and starts no capture on create. enabled=false cannot be combined with browser category settings.
    - `browser` BrowserTelemetryCategoriesConfig — Per-category telemetry capture settings layered onto the default set. The operational signals (control, connection, system, captcha) are on by default and are opt-out: set one to enabled=false to stop capturing it. The CDP categories (console, network, page, interaction) and screenshot are off by default and are opt-in: set enabled=true to capture them.
      - `console` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `page` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `interaction` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `network` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `control` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `connection` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `system` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `screenshot` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.
      - `captcha` BrowserTelemetryCategoryConfig — Per-category telemetry configuration.
        - `enabled` boolean — Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction) and screenshot default to false; set true to opt in.

## Other responses

- `401` — Unauthorized – missing or invalid authorization token
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/kernel/apis/kernel-api.md) · [All operations](https://skmtc.net/kernel/apis/kernel-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kernel/kernel-api/versions/9e8ce9fcf5e1/schema)