Read per-connection signing-key rotation progress
GET /v1/connections/{conn}/sp_key_rotations: Read per-connection signing-key rotation progress.
GET /
Requires a current human CLI or dashboard session with connections:read in the selected environment. Returns public certificates and progress only. A connection with no rotation scheduled yet answers 404 resource_not_found (never an empty body); conflicting transitions answer 409 with sp_key_rotation_conflict, sp_key_rotation_not_ready, sp_key_rotation_key_in_use or sp_key_rotation_unsupported.
- Scope
connections:read- Auth
- Access token
- 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
Responses
Section titled “Responses”- 200 Current rotation progress SPKeyRotation
- 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 GET \ "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations" \ -H "Authorization: Bearer $OHAUTHCAT_ACCESS_TOKEN"const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_ACCESS_TOKEN}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_ACCESS_TOKEN']}"},)data = response.json(){ "object": "sp_key_rotation", "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "generation": "1", "state": "staged", "current_key": { "id": "spk_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "key_id": "key_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "certificate": "MIIC8DCCAdigAwIBAgIQ...base64 PEM body..." }, "previous_key": { "id": "spk_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "key_id": "key_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "certificate": "MIIC8DCCAdigAwIBAgIQ...base64 PEM body..." }, "next_key": { "id": "spk_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "key_id": "key_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "certificate": "MIIC8DCCAdigAwIBAgIQ...base64 PEM body..." }, "pending_reasons": [ "notice_required" ], "doctor": { "error_code": "saml_signature_invalid", "idp": "okta", "cause": "The IdP signed the response with an unexpected certificate.", "it_admin_message": "The IdP signed the response with an unexpected certificate.", "fix_guide_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "steps": [ "acs" ] }, "test": { "sign_in_id": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "generation": "1", "sp_key_id": "spk_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "verified_at": "2026-01-15T09:30:00Z" }, "acknowledged_at": "2026-01-15T09:30:00Z", "test_eligible_at": "2026-01-15T09:30:00Z", "submission": { "requested": 0, "pending": 0, "submitted": 0, "uncertain": 0, "skipped": 0 }, "confirmed_at": "2026-01-15T09:30:00Z", "activated_at": "2026-01-15T09:30:00Z", "rolled_back_at": "2026-01-15T09:30:00Z", "retired_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z"}