- Purpose
- Understand saved state, replacement secrets and the authenticated temporary reveal action.
- Prerequisites
- Administrator access to both applications
- Server-side secret storage
- Architecture
- Integration Studio represents the external client or LMS. API Exams App represents the assessment provider. Exam Player is the candidate-facing browser application.
Configuration
| Normal Connection response | Contains secretConfigured flags, never plaintext secrets |
| Reveal | Authenticated Studio administrator only; explicit secret names; Cache-Control: no-store |
| Not revealable | LTI private signing keys and PEM/key files |
Implementation steps
- 01Open Integration Studio → Connections → API Exams and edit a field.
- 02The relevant section becomes dirty. Click its Save button or the main Save Connection button and wait for the server confirmation.
- 03A success toast means the server persisted the configuration. Navigate away and return or refresh to verify it.
- 04Saved REST, Simulator Control and webhook secrets are masked by default. Click the eye to request the current saved value through an authenticated no-store server action.
- 05Click eye-off to hide it. Viewing does not modify the secret or make the section dirty.
- 06To replace a secret, hide the current value, enter a new value, and save. Leaving the replacement field empty preserves the existing secret.
- 07A page refresh, Connection change or unmount returns revealed secrets to the masked state.
- 08REST credentials are configured in API Exams → Integration Clients → REST Client Authentication. Click Save Integration Client, then use the same REST username and password here; they are different from browser administrator credentials.
- 09The displayed application version identifies the deployed release.
Testing procedure
- Save toast appears only after persistence succeeds
- Secret remains masked after refresh
- Unchanged secrets survive unrelated edits
Troubleshooting
Could not save configuration
Your entered values remain in the form. Correct the validation error and retry; a failed save does not silently restore defaults.
No saved secret is configured
Enter and save a replacement secret, or configure the documented environment fallback where supported.