Confirm the latest eligible next-key test
POST /v1/connections/{conn}/sp_key_rotations/confirm: Confirm the latest eligible next-key test.
POST /
Mutations require a current project administrator using a CLI credential or dashboard session; secret API keys cannot authorize them.
- Scope
connections:write- 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
Request body
Section titled “Request body”
Canonical decimal signed 64-bit generation; strings preserve precision in every client.generationstring Required
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 POST \ "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/confirm" \ -H "Authorization: Bearer $OHAUTHCAT_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "generation": "1"}'const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/confirm", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_ACCESS_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ "generation": "1" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/confirm", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_ACCESS_TOKEN']}"}, json={ "generation": "1", },)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"}