Skip to content

Adopt Framework

POST
/compliance/adoptions

Adopt (or re-pin) a framework for a tenant against the newest published release, optionally scoped by a profile. Idempotent per (tenant, framework): re-adopting updates the pin and profile. Emits catalog.framework_adopted in the same transaction (invariant 2).

Adoption then starts a compliance scan (A53): the tenant’s resources are read and evaluated against the newly activated controls, so the matrix reflects the account rather than reading entirely not-demonstrated until someone deploys something. The scan is accepted, not awaited, the response carries scan_job_id for the page to poll.

st_session
Any of:
string
AdoptionRequest
object
framework
required
Framework
string
profile_key
Any of:
string
tenant_id
required
Tenant Id
string format: uuid

Successful Response

AdoptionRecord
object
adopted_at
required
Adopted At
string format: date-time
adopted_by
required
Adopted By
string
framework
required
Framework
string
framework_version
required
Framework Version
string
id
required
Id
string format: uuid
profile_key
required
Any of:
string
release_version
required
Release Version
string
requirement_count
required
Requirement Count
integer
scan_job_id
Any of:
string format: uuid
scan_skipped_reason
Any of:
string
tenant_id
required
Tenant Id
string format: uuid
upgrade_available
required
Upgrade Available
boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string