DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP

List auth connections

List auth connections with optional filters for profile_name and domain.

GET/auth/connections

List auth connections with optional filters for profile_name and domain.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

profile_name?string

Filter by profile name

domain?string

Filter by domain

limit?integer

Maximum number of results to return

Rangevalue <= 100
Default20
offset?integer

Number of results to skip

Default0
query?string

Search auth connections by ID, domain, or profile name.

Response

application/json

List of auth connections

[index: integer]?

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.

curl -X GET "https://example.com/auth/connections"
[  {    "id": "string",    "profile_name": "string",    "domain": "string",    "status": "AUTHENTICATED",    "last_auth_check_at": "2019-08-24T14:15:22Z",    "last_auth_at": "2019-08-24T14:15:22Z",    "credential": {      "name": "string",      "provider": "string",      "path": "string",      "auto": true    },    "can_reauth": true,    "can_reauth_reason": "external_credential",    "proxy_id": "string",    "allowed_domains": [      "string"    ],    "login_url": "http://example.com",    "post_login_url": "http://example.com",    "flow_status": "IN_PROGRESS",    "flow_step": "DISCOVERING",    "flow_type": "LOGIN",    "flow_expires_at": "2019-08-24T14:15:22Z",    "fields": [      {        "id": "string",        "ref": "string",        "type": "identifier",        "label": "string",        "required": true,        "observed_selector": "string"      }    ],    "choices": [      {        "id": "string",        "type": "mfa_method",        "label": "string",        "description": "string",        "observed_selector": "string"      }    ],    "discovered_fields": [      {        "name": "string",        "type": "text",        "label": "string",        "placeholder": "string",        "required": true,        "selector": "string",        "linked_mfa_type": "sms",        "hint": "string"      }    ],    "mfa_options": [      {        "type": "sms",        "label": "string",        "target": "string",        "description": "string"      }    ],    "sign_in_options": [      {        "id": "string",        "label": "string",        "description": "string"      }    ],    "pending_sso_buttons": [      {        "selector": "string",        "provider": "string",        "label": "string"      }    ],    "external_action_message": "string",    "website_error": "string",    "sso_provider": "string",    "error_message": "string",    "error_code": "string",    "hosted_url": "http://example.com",    "live_view_url": "http://example.com",    "browser_session_id": "string",    "health_check_interval": 300,    "health_checks": true,    "auto_reauth": true,    "save_credentials": true,    "record_session": true  }]

postFlush all idle browsers in the pool

Destroys all idle browsers in the pool; leased browsers are not affected.

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

XGitHubLinkedIn