DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP
GET/auth/connections/{id}

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

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Auth connection ID

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/auth/connections/string"
{  "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}

Create auth connection POST

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.

Update auth connection PATCH

Update an auth connection's configuration. Only the fields provided will be updated.