Start connecting an end user to a provider
POST /v1/pipes/connections: Start connecting an end user to a provider.
POST /v1/pipes/connections
Returns the hosted connect_url to send the end user to (valid 10 minutes, usable once). The flow is the authorization code grant with PKCE (S256); its state is bound to this environment, organization and user. After the provider answers, the end user returns to return_url (one of the environment’s registered redirect URIs) with pipe_connection and status (connected or error) query parameters. One connection exists per provider, organization and user; connecting again reuses it.
- Scope
pipes:write- Auth
- Secret key (
sk_…) - Since
- 1.1
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”providerstring Requiredmax length 64
organization_idstring Requireduser_idstring Requiredmin length 1 · max length 256
One of the environment’s registered redirect URIs.return_urlstring Requiredmax length 2048
Responses
Section titled “Responses”- 201 OK PipeConnectSession
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/pipes/connections" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "provider": "okta", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "user_id": "user_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "return_url": "https://app.acme.com/callback"}'const response = await fetch("https://api.ohauthcat.com/v1/pipes/connections", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "provider": "okta", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "user_id": "user_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "return_url": "https://app.acme.com/callback" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/pipes/connections", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "provider": "okta", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "user_id": "user_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "return_url": "https://app.acme.com/callback", },)data = response.json(){ "object": "pipe_connect_session", "connection": { "object": "pipe_connection", "id": "pipe_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "provider": "okta", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "user_id": "user_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "state": "pending", "scopes": [ "organizations:read" ], "last_error": "saml_signature_invalid", "connected_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z" }, "connect_url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z"}