Update compliance document

PATCH

/orgs/compliance_documents/update/v1/:org_compliance_document_id

PATCH

/orgs/compliance_documents/update/v1/:org_compliance_document_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.orgs.complianceDocuments.updateV1("org_compliance_document_id", {});
8 }
9 main();

1 {
2   "schema_version": 1,
3   "_id": "doc_9f8b7c6d5a4e3f2b1c0d",
4   "org_type": "provider",
5   "org_id": "org_1234567890abcdef",
6   "document_type": "security_threat_assessment",
7   "description": "Annual security threat assessment report for 2024, detailing risk analysis and mitigation strategies.",
8   "org_compliance_document_s3_object_metadata_ids": [
9     "s3meta_abcdef1234567890"
10   ],
11   "valid_from": "2024-01-15T09:30:00Z",
12   "valid_until": "2025-01-15T09:30:00Z"
13 }

Updates an organization compliance document for the caller’s provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

org_compliance_document_idstringRequired

Request

This endpoint expects an object.

descriptionstringOptional<=524288 characters

description__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

schema_versioninteger

_idstring

org_typeenum

org_idstring

Must be a string starting with org_

document_typeenum

descriptionstring<=524288 characters

org_compliance_document_s3_object_metadata_idslist of strings

valid_fromdatetime

valid_untildatetime

Errors

422

Compliance Documents Update V1request Unprocessable Entity Error