Skip to content
Dashboard
Theme
Theme

Restore the preceding signing key before retirement

POST /v1/connections/{conn}/sp_key_rotations/rollback: Restore the preceding signing key before retirement.

View Markdown

POST /v1/connections/{conn}/sp_key_rotations/rollback

Requires a current project administrator using a CLI credential or dashboard session; secret API keys cannot authorize it. Restores the exact preceding key of the requested activated generation without changing shared defaults. A repeated rollback returns the persisted result; retirement ends this rollback right.

Scope
connections:write
Auth
Access token
Since
1.0
  • conn string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • generation string Required

    Canonical decimal signed 64-bit generation; strings preserve precision in every client.

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/rollback" \
-H "Authorization: Bearer $OHAUTHCAT_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"generation": "1"
}'
Response 200
{
"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"
}