POST /
The link can no longer be opened, and sessions opened with it end at once.
- Scope
portal_links:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”linkstring 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
Responses
Section titled “Responses”- 200 OK PortalLinkInfo
- 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/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "completion": { "features": [ "sso" ], "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "directory": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "portal_setup_completion", "completed_at": "2026-01-15T09:30:00Z" }, "profile": "pprof_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "id": "plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "portal_link", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "intents": [ "sso" ], "state": "pending", "expires_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z", "opened_at": "2026-01-15T09:30:00Z"}