Share a connection with another organization
POST /v1/connections/{conn}/shares: Share a connection with another organization.
POST /
Lets another organization of the same environment sign in through this connection (an external connection). The owner organization must consent explicitly (owner_consent: true), and every routing domain must be a domain the target organization verified; sign-ins for those domains route to the target organization and are checked against its verified domains. Sharing is never possible across environments. Answers connection_share_invalid otherwise.
- Scope
connections:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”connstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”organizationstring Required
Domains the target organization verified; sign-ins for them route to it.routing_domainsarray of string Requiredmin items 1 · max items 20
Must be true; records that the owner organization consented to the share.owner_consentboolean Required
Responses
Section titled “Responses”- 201 OK ConnectionShare
- 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
- 409 Codes: idempotency_key_reused and resource-specific conflicts. 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/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/shares" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "routing_domains": [ "acme.com" ], "owner_consent": true}'const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/shares", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "routing_domains": [ "acme.com" ], "owner_consent": true }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/shares", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "routing_domains": [ "acme.com", ], "owner_consent": True, },)data = response.json(){ "id": "cshr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "connection_share", "connection_id": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "owner_organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "routing_domains": [ "acme.com" ], "created_at": "2026-01-15T09:30:00Z", "revoked_at": "2026-01-15T09:30:00Z"}