Controls
Adopt a framework
Adopts a compliance framework for the organization and creates its controls using the selected starter mode.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organizations/string/frameworks/adopt" \ -H "Content-Type: application/json" \ -d '{ "frameworkId": "string", "starterMode": "recommended" }'{ "organizationFramework": { "id": "string", "organizationId": "string", "frameworkId": "string", "status": "planning", "controlMode": "recommended", "scopeDescription": "string", "inScopeCategories": [ "string" ], "attestationStartedAt": "string", "attestationCompletedAt": "string", "attestationReportDocumentId": "string", "audit": { "id": "string", "firmName": "string", "auditPeriodStart": "string", "auditPeriodEnd": "string", "status": "active", "property1": null, "property2": null }, "dateCreated": null, "dateUpdated": null, "frameworkKey": "string", "frameworkShortName": "string", "frameworkName": "string", "frameworkVersion": "string", "frameworkAuthority": "string", "frameworkCategory": "string", "frameworkDescription": "string", "frameworkLicense": "string", "property1": null, "property2": null }, "controlsCreated": 0, "controlsRestored": 0}