Rotate an app secret
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/oauth_apps/{client_id}/rotate_secretIssue a new client secret for a confidential app. The previous secret keeps working for grace_seconds so you can deploy the new one without failed sign-ins.
For how this fits into a full workflow, see Build a Sign in with Syntic app.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | oauth-apps-2026-12-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Idempotency-Key | No | Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of acting twice. See Idempotency. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
client_id | string | The app’s client id, starting with oapp_. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
grace_seconds | integer | No | 0 to 604,800. Default 86,400. |
Response
200 OK, Content-Type: application/json
{
"client_id": "oapp_01JD79H1K3M5P7R9T1V3",
"client_secret": "scs_live_8Pk…redacted",
"previous_secret_expires_at": "2026-11-05T11:00:00Z"
}Examples
curl -sS "https://app.syntic.ai/v1/organizations/oauth_apps/oapp_01JD79H1K3M5P7R9T1V3/rotate_secret" \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: oauth-apps-2026-12-01" \
-H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
-H "Content-Type: application/json" \
-d '{
"grace_seconds": 3600
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 400 | invalid_request_error | public_client | Public apps have no secret. |
| 404 | not_found_error | oauth_app_not_found | No app with this client id in the organization. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?