API Authentication¶
SecureObs has two authentication paths:
- dashboard users authenticate with Microsoft Entra ID bearer tokens;
- CI pipelines authenticate with SecureObs API keys.
API Keys¶
Pipeline requests send:
The raw API key is shown once in the dashboard. SecureObs stores only a SHA-256 hash.
Key Scope¶
| Scope | Behavior |
|---|---|
| Tenant-scoped | Can ingest for projects in the tenant |
| Project-scoped | Can ingest only for the selected project |
Prefer project-scoped keys for CI.
Rotation¶
- Create a new API key in SecureObs.
- Update the CI secret.
- Re-run the pipeline.
- Revoke the old key.
Revocation is effective on the next request.
Self-Hosted API URL¶
The scanner defaults to:
For self-hosted deployments, set:
The value must include the /api suffix.