{ "$schema" : "http://json-schema.org/draft-07/schema#", "$id" : "http://csrc.nist.gov/ns/oscal/1.0-schema.json", "$comment" : "OSCAL Profile Model: JSON Schema", "type" : "object", "definitions" : { "metadata" : { "title" : "Publication metadata", "description" : "Provides information about the publication and availability of the containing document.", "$id" : "#/definitions/metadata", "type" : "object", "properties" : { "title" : { "title" : "Document Title", "description" : "A name given to the document, which may be used by a tool for display and navigation.", "type" : "string" }, "published" : { "$ref" : "#/definitions/oscal-metadata-published" }, "last-modified" : { "$ref" : "#/definitions/oscal-metadata-last-modified" }, "version" : { "$ref" : "#/definitions/oscal-metadata-version" }, "oscal-version" : { "$ref" : "#/definitions/oscal-metadata-oscal-version" }, "revisions" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-revision" } }, "document-ids" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-document-id" } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "roles" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/role" } }, "locations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/location" } }, "parties" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/party" } }, "responsible-parties" : { "type" : "object", "minProperties" : 1, "additionalProperties" : { "allOf" : [ { "$ref" : "#/definitions/responsible-party" }, { "not" : { "type" : "string" } } ] } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "title", "last-modified", "version", "oscal-version" ], "additionalProperties" : false }, "oscal-metadata-revision" : { "title" : "Revision History Entry", "description" : "An entry in a sequential list of revisions to the containing document in reverse chronological order (i.e., most recent previous revision first).", "$id" : "#/definitions/oscal-metadata-revision", "type" : "object", "properties" : { "title" : { "title" : "Document Title", "description" : "A name given to the document revision, which may be used by a tool for display and navigation.", "type" : "string" }, "published" : { "$ref" : "#/definitions/oscal-metadata-published" }, "last-modified" : { "$ref" : "#/definitions/oscal-metadata-last-modified" }, "version" : { "$ref" : "#/definitions/oscal-metadata-version" }, "oscal-version" : { "$ref" : "#/definitions/oscal-metadata-oscal-version" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "additionalProperties" : false }, "location" : { "title" : "Location", "description" : "A location, with associated metadata that can be referenced.", "$id" : "#/definitions/location", "type" : "object", "properties" : { "uuid" : { "title" : "Location Universally Unique Identifier", "description" : "A unique identifier that can be used to reference this defined location elsewhere in an OSCAL document. A UUID should be consistantly used for a given location across revisions of the document.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "title" : { "title" : "Location Title", "description" : "A name given to the location, which may be used by a tool for display and navigation.", "type" : "string" }, "address" : { "$ref" : "#/definitions/oscal-metadata-address" }, "email-addresses" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-email-address" } }, "telephone-numbers" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-telephone-number" } }, "urls" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Location URL", "description" : "The uniform resource locator (URL) for a web site or Internet presence associated with the location.", "type" : "string", "format" : "uri" } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "uuid", "address" ], "additionalProperties" : false }, "location-uuid" : { "title" : "Location Reference", "description" : "References a location defined in metadata.", "$id" : "#/definitions/location-uuid", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "party" : { "title" : "Party (organization or person)", "description" : "A responsible entity which is either a person or an organization.", "$id" : "#/definitions/party", "type" : "object", "properties" : { "uuid" : { "title" : "Party Universally Unique Identifier", "description" : "A unique identifier that can be used to reference this defined location elsewhere in an OSCAL document. A UUID should be consistantly used for a given party across revisions of the document.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "type" : { "title" : "Party Type", "description" : "A category describing the kind of party the object describes.", "type" : "string", "enum" : [ "person", "organization" ] }, "name" : { "title" : "Party Name", "description" : "The full name of the party. This is typically the legal name associated with the party.", "type" : "string" }, "short-name" : { "title" : "Party Short Name", "description" : "A short common name, abbreviation, or acronym for the party.", "type" : "string" }, "external-ids" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Party External Identifier", "description" : "An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID)", "type" : "object", "properties" : { "scheme" : { "title" : "External Identifier Schema", "description" : "Indicates the type of external identifier.", "type" : "string", "format" : "uri" }, "id" : { "type" : "string" } }, "required" : [ "id", "scheme" ], "additionalProperties" : false } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "email-addresses" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-email-address" } }, "telephone-numbers" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-telephone-number" } }, "addresses" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-address" } }, "location-uuids" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/location-uuid" } }, "member-of-organizations" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Organizational Affiliation", "description" : "Identifies that the party object is a member of the organization associated with the provided UUID.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "uuid", "type" ], "additionalProperties" : false }, "party-uuid" : { "title" : "Party Reference", "description" : "References a party defined in metadata.", "$id" : "#/definitions/party-uuid", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "role" : { "title" : "Role", "description" : "Defines a function assumed or expected to be assumed by a party in a specific situation.", "$id" : "#/definitions/role", "type" : "object", "properties" : { "id" : { "title" : "Role Identifier", "description" : "A unique identifier for a specific role instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same role across minor revisions of the document.", "type" : "string" }, "title" : { "title" : "Role Title", "description" : "A name given to the role, which may be used by a tool for display and navigation.", "type" : "string" }, "short-name" : { "title" : "Role Short Name", "description" : "A short common name, abbreviation, or acronym for the role.", "type" : "string" }, "description" : { "title" : "Role Description", "description" : "A summary of the role's purpose and associated responsibilities.", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "id", "title" ], "additionalProperties" : false }, "back-matter" : { "title" : "Back matter", "description" : "A collection of resources, which may be included directly or by reference.", "$id" : "#/definitions/back-matter", "type" : "object", "properties" : { "resources" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Resource", "description" : "A resource associated with content in the containing document. A resource may be directly included in the document base64 encoded or may point to one or more equavalent internet resources.", "type" : "object", "properties" : { "uuid" : { "title" : "Resource Universally Unique Identifier", "description" : "A globally unique identifier that can be used to reference this defined resource elsewhere in an OSCAL document. A UUID should be consistantly used for a given resource across revisions of the document.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "title" : { "title" : "Resource Title", "description" : "A name given to the resource, which may be used by a tool for display and navigation.", "type" : "string" }, "description" : { "title" : "Resource Description", "description" : "A short summary of the resource used to indicate the purpose of the resource.", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "document-ids" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-document-id" } }, "citation" : { "title" : "Citation", "description" : "A citation consisting of end note text and optional structured bibliographic data.", "type" : "object", "properties" : { "text" : { "title" : "Citation Text", "description" : "A line of citation text.", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "biblio" : { "title" : "Bibliographic Definition", "description" : "A container for structured bibliographic information. The model of this information is undefined by OSCAL.", "type" : "object", "additionalProperties" : true } }, "required" : [ "text" ], "additionalProperties" : false }, "rlinks" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Resource link", "description" : "A pointer to an external resource with an optional hash for verification and change detection.", "type" : "object", "properties" : { "href" : { "title" : "Hypertext Reference", "description" : "A resolvable URI reference to a resource.", "type" : "string", "format" : "uri-reference" }, "media-type" : { "title" : "Media Type", "description" : "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type" : "string" }, "hashes" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/hash" } } }, "required" : [ "href" ], "additionalProperties" : false } }, "base64" : { "title" : "Base64", "description" : "The Base64 alphabet in RFC 2045 - aligned with XSD.", "type" : "object", "properties" : { "filename" : { "title" : "File Name", "description" : "Name of the file before it was encoded as Base64 to be embedded in a resource. This is the name that will be assigned to the file when the file is decoded.", "type" : "string", "format" : "uri-reference" }, "media-type" : { "title" : "Media Type", "description" : "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type" : "string" }, "value" : { "type" : "string" } }, "required" : [ "value" ], "additionalProperties" : false }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "uuid" ], "additionalProperties" : true } } }, "additionalProperties" : false }, "property" : { "title" : "Property", "description" : "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair. The value of a property is a simple scalar value, which may be expressed as a list of values in some OSCAL formats.", "$id" : "#/definitions/property", "type" : "object", "properties" : { "uuid" : { "title" : "Property Universally Unique Identifier", "description" : "A unique identifier that can be used to reference this property elsewhere in an OSCAL document. A UUID should be consistantly used for a given location across revisions of the document.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "name" : { "title" : "Property Name", "description" : "A textual label that uniquely identifies a specific attribute, characteristic, or quality of the property's containing object.", "type" : "string" }, "ns" : { "title" : "Property Namespace", "description" : "A namespace qualifying the property's name. This allows different organizations to associate distinct semantics with the same name.", "type" : "string", "format" : "uri" }, "class" : { "title" : "Property Class", "description" : "A textual label that provides a sub-type or characterization of the property's name. This can be used to further distinguish or discriminate between the semantics of multiple properties of the same object with the same name and ns.", "type" : "string" }, "value" : { "type" : "string" } }, "required" : [ "value", "name" ], "additionalProperties" : false }, "annotation" : { "title" : "Annotated Property", "description" : "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair with optional explanatory remarks. The value of an annotated property is a simple scalar value.", "$id" : "#/definitions/annotation", "type" : "object", "properties" : { "name" : { "title" : "Annotated Property Name", "description" : "A textual label that uniquely identifies a specific attribute, characteristic, or quality of the annotated property's containing object.", "type" : "string" }, "uuid" : { "title" : "Annotated Property Universally Unique Identifier", "description" : "A unique identifier that can be used to reference this annotated property elsewhere in an OSCAL document. A UUID should be consistantly used for a given location across revisions of the document.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "ns" : { "title" : "Annotated Property Namespace", "description" : "A namespace qualifying the annotated property's name. This allows different organizations to associate distinct semantics with the same name.", "type" : "string", "format" : "uri" }, "value" : { "title" : "Annotated Property Value", "description" : "Indicates the value of the attribute, characteristic, or quality.", "type" : "string" }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "name", "value" ], "additionalProperties" : false }, "link" : { "title" : "Link", "description" : "A reference to a local or remote resource", "$id" : "#/definitions/link", "type" : "object", "properties" : { "href" : { "title" : "Hypertext Reference", "description" : "A resolvable URL reference to a resource.", "type" : "string", "format" : "uri-reference" }, "rel" : { "title" : "Relation", "description" : "Describes the type of relationship provided by the link. This can be an indicator of the link's purpose.", "type" : "string" }, "media-type" : { "title" : "Media Type", "description" : "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type" : "string" }, "text" : { "title" : "Link Text", "description" : "A textual label to associate with the link, which may be used for presentation in a tool.", "type" : "string" } }, "required" : [ "href" ], "additionalProperties" : false }, "responsible-party" : { "title" : "Responsible Party", "description" : "A reference to a set of organizations or persons that have responsibility for performing a referenced role in the context of the containing object.", "$id" : "#/definitions/responsible-party", "type" : "object", "properties" : { "party-uuids" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/party-uuid" } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "party-uuids" ], "additionalProperties" : false }, "hash" : { "title" : "Hash", "description" : "A representation of a cryptographic digest generated over a resource using a specified hash algorithm.", "$id" : "#/definitions/hash", "type" : "object", "properties" : { "algorithm" : { "title" : "Hash algorithm", "description" : "Method by which a hash is derived", "type" : "string" }, "value" : { "type" : "string" } }, "required" : [ "value", "algorithm" ], "additionalProperties" : false }, "remarks" : { "title" : "Remarks", "description" : "Additional commentary on the containing object.", "$id" : "#/definitions/remarks", "type" : "string" }, "oscal-metadata-published" : { "title" : "Publication Timestamp", "description" : "The date and time the document was published. The date-time value must be formatted according to RFC 3339 with full time and time zone included.", "$id" : "#/definitions/oscal-metadata-published", "type" : "string", "format" : "date-time", "pattern" : "^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$" }, "oscal-metadata-last-modified" : { "title" : "Last Modified Timestamp", "description" : "The date and time the document was last modified. The date-time value must be formatted according to RFC 3339 with full time and time zone included.", "$id" : "#/definitions/oscal-metadata-last-modified", "type" : "string", "format" : "date-time", "pattern" : "^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$" }, "oscal-metadata-version" : { "title" : "Document Version", "description" : "A string used to distinguish the current version of the document from other previous (and future) versions.", "$id" : "#/definitions/oscal-metadata-version", "type" : "string" }, "oscal-metadata-oscal-version" : { "title" : "OSCAL version", "description" : "The OSCAL model version the document was authored against.", "$id" : "#/definitions/oscal-metadata-oscal-version", "type" : "string" }, "oscal-metadata-email-address" : { "title" : "Email Address", "description" : "An email address as defined by RFC 5322 Section 3.4.1.", "$id" : "#/definitions/oscal-metadata-email-address", "type" : "string", "format" : "email", "pattern" : "^.+@.+" }, "oscal-metadata-telephone-number" : { "title" : "Telephone Number", "description" : "Contact number by telephone.", "$id" : "#/definitions/oscal-metadata-telephone-number", "type" : "object", "properties" : { "type" : { "title" : "type flag", "description" : "Indicates the type of phone number.", "type" : "string" }, "number" : { "type" : "string" } }, "required" : [ "number" ], "additionalProperties" : false }, "oscal-metadata-address" : { "title" : "Address", "description" : "A postal address for the location.", "$id" : "#/definitions/oscal-metadata-address", "type" : "object", "properties" : { "type" : { "type" : "string" }, "addr-lines" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/oscal-metadata-addr-line" } }, "city" : { "title" : "City", "description" : "City, town or geographical region for the mailing address.", "type" : "string" }, "state" : { "title" : "State", "description" : "State, province or analogous geographical region for mailing address", "type" : "string" }, "postal-code" : { "title" : "Postal Code", "description" : "Postal or ZIP code for mailing address", "type" : "string" }, "country" : { "title" : "Country Code", "description" : "The ISO 3166-1 alpha-2 country code for the mailing address.", "type" : "string" } }, "additionalProperties" : false }, "oscal-metadata-addr-line" : { "title" : "Address line", "description" : "A single line of an address.", "$id" : "#/definitions/oscal-metadata-addr-line", "type" : "string" }, "oscal-metadata-document-id" : { "title" : "Document Identifier", "description" : "A document identifier qualified by an identifier type.", "$id" : "#/definitions/oscal-metadata-document-id", "type" : "object", "properties" : { "scheme" : { "title" : "Document Identification Scheme", "description" : "Qualifies the kind of document identifier.", "type" : "string", "format" : "uri" }, "identifier" : { "type" : "string" } }, "required" : [ "identifier", "scheme" ], "additionalProperties" : false }, "part" : { "title" : "Part", "description" : "A partition of a control's definition or a child of another part.", "$id" : "#/definitions/part", "type" : "object", "properties" : { "id" : { "title" : "Part Identifier", "description" : "A unique identifier for a specific part instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same part across minor revisions of the document.", "type" : "string" }, "name" : { "title" : "Part Name", "description" : "A textual label that uniquely identifies the part's semantic type.", "type" : "string" }, "ns" : { "title" : "Part Namespace", "description" : "A namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.", "type" : "string", "format" : "uri" }, "class" : { "title" : "Part Class", "description" : "A textual label that provides a sub-type or characterization of the part's name. This can be used to further distinguish or discriminate between the semantics of multiple parts of the same control with the same name and ns.", "type" : "string" }, "title" : { "title" : "Part Title", "description" : "A name given to the part, which may be used by a tool for display and navigation.", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "prose" : { "title" : "Part Text", "description" : "Permits multiple paragraphs, lists, tables etc.", "type" : "string" }, "parts" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/part" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } } }, "required" : [ "name" ], "additionalProperties" : true }, "parameter" : { "title" : "Parameter", "description" : "Parameters provide a mechanism for the dynamic assignment of value(s) in a control.", "$id" : "#/definitions/parameter", "type" : "object", "properties" : { "id" : { "title" : "Parameter Identifier", "description" : "A unique identifier for a specific parameter instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same parameter across minor revisions of the document.", "type" : "string" }, "class" : { "title" : "Parameter Class", "description" : "A textual label that provides a characterization of the parameter.", "type" : "string" }, "depends-on" : { "title" : "Depends on", "description" : "Another parameter invoking this one", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "label" : { "title" : "Parameter Label", "description" : "A short, placeholder name for the parameter, which can be used as a subsitute for a value if no value is assigned.", "type" : "string" }, "usage" : { "title" : "Parameter Usage Description", "description" : "Describes the purpose and use of a parameter", "type" : "string" }, "constraints" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-constraint" } }, "guidelines" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-guideline" } }, "values" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-value" } }, "select" : { "$ref" : "#/definitions/parameter-selection" }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "id" ], "additionalProperties" : true }, "parameter-constraint" : { "title" : "Constraint", "description" : "A formal or informal expression of a constraint or test", "$id" : "#/definitions/parameter-constraint", "type" : "object", "properties" : { "description" : { "title" : "Constraint Description", "description" : "A textual summary of the constraint to be applied.", "type" : "string" }, "tests" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Constraint Test", "description" : "A test expression which is expected to be evaluated by a tool.", "type" : "object", "properties" : { "expression" : { "title" : "Constraint test", "description" : "A formal (executable) expression of a constraint", "type" : "string" }, "remarks" : { "$ref" : "#/definitions/remarks" } }, "required" : [ "expression" ], "additionalProperties" : false } } }, "additionalProperties" : false }, "parameter-guideline" : { "title" : "Guideline", "description" : "A prose statement that provides a recommendation for the use of a parameter.", "$id" : "#/definitions/parameter-guideline", "type" : "object", "properties" : { "prose" : { "title" : "Guideline Text", "description" : "Prose permits multiple paragraphs, lists, tables etc.", "type" : "string" } }, "required" : [ "prose" ], "additionalProperties" : true }, "parameter-value" : { "title" : "Parameter Value", "description" : "A parameter value or set of values.", "$id" : "#/definitions/parameter-value", "type" : "string" }, "parameter-selection" : { "title" : "Selection", "description" : "Presenting a choice among alternatives", "$id" : "#/definitions/parameter-selection", "type" : "object", "properties" : { "how-many" : { "title" : "Parameter Cardinality", "description" : "Describes the number of selections that must occur.", "type" : "string" }, "choice" : { "type" : "array", "minItems" : 1, "items" : { "title" : "Choice", "description" : "A value selection among several such options", "type" : "string" } } }, "additionalProperties" : true }, "profile" : { "title" : "Profile", "description" : "Each OSCAL profile is defined by a Profile element", "$id" : "#/definitions/profile", "type" : "object", "properties" : { "uuid" : { "title" : "Catalog Universally Unique Identifier", "description" : "A globally unique identifier for this profile instance. This UUID should be changed when this document is revised.", "type" : "string", "pattern" : "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "metadata" : { "$ref" : "#/definitions/metadata" }, "imports" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/import" } }, "merge" : { "$ref" : "#/definitions/merge" }, "modify" : { "$ref" : "#/definitions/modify" }, "back-matter" : { "$ref" : "#/definitions/back-matter" } }, "required" : [ "uuid", "metadata", "imports" ], "additionalProperties" : false }, "import" : { "title" : "Import resource", "description" : "An Import element designates a catalog, profile, or other resource to be included (referenced and potentially modified) by this profile.", "$id" : "#/definitions/import", "type" : "object", "properties" : { "href" : { "title" : "Catalog or Profile Reference", "description" : "A resolvable URL reference to the base catalog or profile that this profile is tailoring.", "type" : "string", "format" : "uri-reference" }, "include" : { "$ref" : "#/definitions/include" }, "exclude" : { "$ref" : "#/definitions/exclude" } }, "required" : [ "href" ], "additionalProperties" : false }, "merge" : { "title" : "Merge controls", "description" : "A Merge element merges controls in resolution.", "$id" : "#/definitions/merge", "type" : "object", "properties" : { "combine" : { "$ref" : "#/definitions/combine" }, "as-is" : { "$ref" : "#/definitions/as-is" }, "custom" : { "$ref" : "#/definitions/custom" } }, "additionalProperties" : false }, "combine" : { "title" : "Combination rule", "description" : "A Combine element defines whether and how to combine multiple (competing) versions of the same control", "$id" : "#/definitions/combine", "type" : "object", "properties" : { "method" : { "title" : "Combination method", "description" : "How clashing controls should be handled", "type" : "string", "enum" : [ "use-first", "merge", "keep" ] } }, "additionalProperties" : false }, "as-is" : { "title" : "As is", "description" : "An As-is element indicates that the controls should be structured in resolution as they are structured in their source catalogs. It does not contain any elements or attributes.", "$id" : "#/definitions/as-is", "type" : "boolean" }, "custom" : { "title" : "Custom grouping", "description" : "A Custom element frames a structure for embedding represented controls in resolution.", "$id" : "#/definitions/custom", "type" : "object", "properties" : { "groups" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/group" } }, "id-selectors" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/call" } }, "pattern-selectors" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/match" } } }, "additionalProperties" : false }, "group" : { "title" : "Control group", "description" : "A group of (selected) controls or of groups of controls", "$id" : "#/definitions/group", "type" : "object", "properties" : { "id" : { "title" : "Group Identifier", "description" : "A unique identifier for a specific group instance that can be used to reference the group within this and in other OSCAL documents. This identifier's uniqueness is document scoped and is intended to be consistent for the same group across minor revisions of the document.", "type" : "string" }, "class" : { "title" : "Group Class", "description" : "A textual label that provides a sub-type or characterization of the group.", "type" : "string" }, "title" : { "title" : "Group Title", "description" : "A name given to the group, which may be used by a tool for display and navigation.", "type" : "string" }, "params" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter" } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "parts" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/part" } }, "groups" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/group" } }, "calls" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/call" } }, "matches" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/match" } } }, "required" : [ "title" ], "additionalProperties" : false }, "modify" : { "title" : "Modify controls", "description" : "Set parameters or amend controls in resolution", "$id" : "#/definitions/modify", "type" : "object", "properties" : { "set-parameters" : { "type" : "object", "minProperties" : 1, "additionalProperties" : { "allOf" : [ { "$ref" : "#/definitions/set-parameter" }, { "not" : { "type" : "string" } } ] } }, "alters" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/alter" } } }, "additionalProperties" : false }, "include" : { "title" : "Include controls", "description" : "Specifies which controls to include from the resource (source catalog) being imported", "$id" : "#/definitions/include", "type" : "object", "properties" : { "all" : { "$ref" : "#/definitions/all" }, "calls" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/call" } }, "matches" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/match" } } }, "additionalProperties" : false }, "all" : { "title" : "Include all", "description" : "Include all controls from the imported resource (catalog)", "$id" : "#/definitions/all", "type" : "object", "properties" : { "with-child-controls" : { "title" : "Include contained controls with control", "description" : "When a control is included, whether its child (dependent) controls are also included.", "type" : "string", "enum" : [ "yes", "no" ] } }, "additionalProperties" : false }, "call" : { "title" : "Call", "description" : "Call a control by its ID", "$id" : "#/definitions/call", "type" : "object", "properties" : { "control-id" : { "title" : "Control ID", "description" : "Value of the 'id' flag on a target control", "type" : "string" }, "with-child-controls" : { "title" : "Include contained controls with control", "description" : "When a control is included, whether its child (dependent) controls are also included.", "type" : "string", "enum" : [ "yes", "no" ] } }, "required" : [ "control-id" ], "additionalProperties" : false }, "match" : { "title" : "Match controls by identifier", "description" : "Select controls by (regular expression) match on ID", "$id" : "#/definitions/match", "type" : "object", "properties" : { "pattern" : { "title" : "Pattern", "description" : "A regular expression matching the IDs of one or more controls to be selected", "type" : "string" }, "order" : { "title" : "Order", "description" : "A designation of how a selection of controls in a profile is to be ordered.", "type" : "string", "enum" : [ "keep", "ascending", "descending" ] }, "with-child-controls" : { "title" : "Include contained controls with control", "description" : "When a control is included, whether its child (dependent) controls are also included.", "type" : "string", "enum" : [ "yes", "no" ] } }, "additionalProperties" : false }, "exclude" : { "title" : "Exclude controls", "description" : "Which controls to exclude from the resource (source catalog) being imported", "$id" : "#/definitions/exclude", "type" : "object", "properties" : { "calls" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/call" } }, "matches" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/match" } } }, "additionalProperties" : false }, "set-parameter" : { "title" : "Parameter Setting", "description" : "A parameter setting, to be propagated to points of insertion", "$id" : "#/definitions/set-parameter", "type" : "object", "properties" : { "class" : { "title" : "Parameter Class", "description" : "A textual label that provides a characterization of the parameter.", "type" : "string" }, "depends-on" : { "title" : "Depends on", "description" : "Another parameter invoking this one", "type" : "string" }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "label" : { "title" : "Parameter Label", "description" : "A short, placeholder name for the parameter, which can be used as a subsitute for a value if no value is assigned.", "type" : "string" }, "usage" : { "title" : "Parameter Usage Description", "description" : "Describes the purpose and use of a parameter", "type" : "string" }, "constraints" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-constraint" } }, "guidelines" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-guideline" } }, "values" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter-value" } }, "select" : { "$ref" : "#/definitions/parameter-selection" } }, "additionalProperties" : false }, "alter" : { "title" : "Alteration", "description" : "An Alter element specifies changes to be made to an included control when a profile is resolved.", "$id" : "#/definitions/alter", "type" : "object", "properties" : { "control-id" : { "title" : "Control ID", "description" : "Value of the 'id' flag on a target control", "type" : "string" }, "removes" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/remove" } }, "adds" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/add" } } }, "additionalProperties" : false }, "remove" : { "title" : "Removal", "description" : "Specifies elements to be removed from a control, in resolution", "$id" : "#/definitions/remove", "type" : "object", "properties" : { "name-ref" : { "title" : "Reference by (assigned) name", "description" : "Items to remove, by assigned name", "type" : "string" }, "class-ref" : { "title" : "Reference by class", "description" : "Items to remove, by class. A token match.", "type" : "string" }, "id-ref" : { "title" : "Reference by ID", "description" : "Items to remove, indicated by their IDs", "type" : "string" }, "item-name" : { "title" : "References by item name or generic identifier", "description" : "Items to remove, by the name of the item's type, or generic identifier, e.g. title or prop", "type" : "string" } }, "additionalProperties" : false }, "add" : { "title" : "Addition", "description" : "Specifies contents to be added into controls, in resolution", "$id" : "#/definitions/add", "type" : "object", "properties" : { "position" : { "title" : "Position", "description" : "Where to add the new content with respect to the targeted element (beside it or inside it)", "type" : "string", "enum" : [ "before", "after", "starting", "ending" ] }, "id-ref" : { "title" : "Reference by ID", "description" : "Target location of the addition.", "type" : "string" }, "title" : { "title" : "Title Change", "description" : "A name given to the control, which may be used by a tool for display and navigation.", "type" : "string" }, "params" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/parameter" } }, "props" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/property" } }, "annotations" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/annotation" } }, "links" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/link" } }, "parts" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/definitions/part" } } }, "additionalProperties" : false } }, "properties" : { "profile" : { "$ref" : "#/definitions/profile" } }, "required" : [ "profile" ], "additionalProperties" : false, "maxProperties" : 1 }