Skip to content

Standard API — Cookbook

Base URL: https://standard-api.bekaa.eu Auth: Cookie session (browser) ou Authorization: Bearer standard_live_... (M2M)


Terminal window
curl -X POST https://standard-api.bekaa.eu/api/auth/sign-in/email \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com", "password": "s3cur3!"}'
Terminal window
curl https://standard-api.bekaa.eu/api/auth/get-session \
-H "Cookie: standard-native-auth.session_token=..."

Terminal window
curl https://standard-api.bekaa.eu/api/v1/users/me/organizations \
-H "Cookie: ..."
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/users/me/orgs/{orgId}/activate \
-H "Cookie: ..."
Terminal window
curl https://standard-api.bekaa.eu/api/v1/organizations/{orgId}/dashboard \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"

Terminal window
curl https://standard-api.bekaa.eu/api/v1/scf/domains \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"
Terminal window
curl "https://standard-api.bekaa.eu/api/v1/scf/controls?domain=ACC" \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"

Buscar controles de um framework (ex: ISO 27001)

Section titled “Buscar controles de um framework (ex: ISO 27001)”
Terminal window
curl "https://standard-api.bekaa.eu/api/v1/scf/controls?framework=ISO+27001" \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/scf/controls/{controlId} \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/scf/frameworks \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"
Terminal window
curl "https://standard-api.bekaa.eu/api/v1/scf/crosswalks?framework=ISO+27001" \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}"

Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments \
-H "Content-Type: application/json" \
-H "Cookie: ..." \
-H "x-standard-tenant-id: {orgId}" \
-d '{"name": "ISO 27001 Q3", "framework_id": "iso-27001"}'
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id} \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/status \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/summary \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/timeline \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"

Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/documents \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-F "file=@policy.pdf" -F "category=policy"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/documents \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/documents/{docId}/chunks \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/documents/{docId}/reprocess \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"

Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/kb/search \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"query": "access control policy for privileged accounts", "assessment_id": "{id}", "top_k": 10}'

Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/gaps \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/gaps \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"control_id": "ACC-01", "status": "not_implemented", "severity": "high"}'

Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/soa \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl https://standard-api.bekaa.eu/api/v1/assessments/{id}/poam \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/reports \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"format": "pdf", "template": "executive_summary"}'

Terminal window
curl https://standard-api.bekaa.eu/api/v1/agent-runtime/agents \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/agent-runs \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"agent_id": "standard-gap-analyst"}'
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/workflows \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"workflow_type": "full_assessment"}'
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/assessments/{id}/lifecycle/transition \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"target_state": "documents_uploaded"}'

Terminal window
curl https://standard-api.bekaa.eu/api/v1/organizations/{orgId}/members \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}"
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/organizations/{orgId}/members/invite \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"email": "analyst@co.com", "role": "member"}'
Terminal window
curl -X POST https://standard-api.bekaa.eu/api/v1/organizations/{orgId}/api-keys \
-H "Content-Type: application/json" \
-H "Cookie: ..." -H "x-standard-tenant-id: {orgId}" \
-d '{"name": "CI Pipeline", "scopes": ["assessment:read", "scf:read"]}'

Terminal window
# Público
curl https://standard-api.bekaa.eu/api/v1/health
# Detalhado (requer auth)
curl https://standard-api.bekaa.eu/api/v1/health/detailed \
-H "Cookie: ..."

Terminal window
# Listar usuários
curl https://standard-api.bekaa.eu/api/v1/admin/users -H "Cookie: ..."
# Listar tenants
curl https://standard-api.bekaa.eu/api/v1/tenants -H "Cookie: ..."
# Banir usuário
curl -X POST https://standard-api.bekaa.eu/api/v1/admin/users/{userId}/ban \
-H "Content-Type: application/json" -H "Cookie: ..." \
-d '{"reason": "Policy violation"}'

HeaderQuandoValor
CookieBrowserstandard-native-auth.session_token=...
AuthorizationM2MBearer standard_live_...
x-standard-tenant-idRotas tenant-scopedUUID da org ativa
Content-TypePOST/PUT/PATCHapplication/json
{"error": {"code": "NOT_FOUND", "message": "Resource not found.", "trace_id": "abc-123"}}
HTTPCódigoSignificado
401UNAUTHORIZEDSessão expirada
403FORBIDDENSem permissão
404NOT_FOUNDRecurso não existe
409CONFLICTEstado inválido
422VALIDATION_ERRORInput inválido
429RATE_LIMITEDRate limit
500INTERNAL_ERRORErro interno