Purpose
Regenerate your organization's API client secret. The old secret stops working immediately in Keycloak — update every integration before or right after rotation.
Console path: API Keys → Credentials card → Rotate secret section.
Prerequisites
- API access Configured (Client ID provisioned)
- Access to update all services that use the current secret
Rotate secret section
Located below the Client ID and Secret fields, separated by a horizontal rule.
| Element | Copy |
|---|---|
| Section title | Rotate secret |
| Description | Regenerating immediately invalidates the current secret in every service that uses it. |
| Primary button | Regenerate secret (destructive/red, refresh icon; icon spins while submitting) |
Console terminology is Regenerate / Rotate secret — there is no separate Revoke or Delete key action. Regenerating is the only way to invalidate a secret.
Confirmation dialog
Opens when you click Regenerate secret. The secret is not rotated until you confirm.
| Element | Copy |
|---|---|
| Dialog title | Regenerate API secret? |
| Dialog description | Existing integrations using the current secret will fail until you update them with the new value. |
| Cancel | Cancel (outline) |
| Confirm | Regenerate secret (destructive) |
HTTP: POST /api-keys/regenerate-secret with preserveScroll: true.
After successful regeneration
- Page reloads with the new secret in session flash.
- Yellow Copy your new secret now alert appears at the top.
- Secret field shows full plaintext (copy enabled).
- Extra Copy secret button appears below the fields.
- API access card shows New secret ready to copy.
There is no success flash toast — success is shown on-page via the warning alert and revealed secret.
Plan the rotation:
- Prepare deployment slots to update environment variables on all servers.
- Click Regenerate secret and confirm.
- Copy the new secret immediately.
- Update every integration — old secret fails instantly.
- Verify API calls succeed with the new credentials.
Server errors (flash toast)
If regeneration fails, a red error toast appears for 5 seconds:
| Trigger | Message |
|---|---|
| No client configured | No API client is configured for your organization yet. Contact support. |
| Keycloak not configured | Credentials Manager is not configured. Set KEYCLOAK_M2M_CLIENT_ID and KEYCLOAK_M2M_CLIENT_SECRET. |
| Missing org client ID | No Keycloak M2M client ID is configured for this organization. |
| Client missing in Keycloak | Client '{id}' not found in Keycloak. |
| HTTP failure | Failed to regenerate secret (HTTP …): … |
See Access & errors for full error catalog.
Steps
-
Open API Keys and scroll to Rotate secret.
-
Click Regenerate secret.
-
Read the dialog — confirm you are ready to update all integrations.
-
Click Regenerate secret in the dialog.
-
Copy the full secret from the warning state — toast Secret copied.
-
Update environment variables on every server, worker, and CI pipeline that calls OmaxTelecom APIs.
-
Test a sample API request before decommissioning old config backups.
Related pages
For authentication flows, endpoints, and request examples, see the OmaxTelecom Developer Portal.