Skip to content

classifications.md

Latest commit

 

History

History
179 lines (131 loc) · 6.51 KB

classifications.md

File metadata and controls

179 lines (131 loc) · 6.51 KB

ClassificationsManager

List all classifications

Retrieves the classification metadata template and lists all the classifications available to this enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

This operation is performed by calling function get_classification_template.

See the endpoint docs at API Reference.

client.classifications.get_classification_template()

Arguments

  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ClassificationTemplate.

Returns the securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

Add classification

Adds one or more new classifications to the list of classifications available to the enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

This operation is performed by calling function add_classification.

See the endpoint docs at API Reference.

client.classifications.add_classification(
    [
        AddClassificationRequestBody(
            data=AddClassificationRequestBodyDataField(
                key=get_uuid(),
                static_config=AddClassificationRequestBodyDataStaticConfigField(
                    classification=AddClassificationRequestBodyDataStaticConfigClassificationField(
                        color_id=4, classification_definition="Other description"
                    )
                ),
            )
        )
    ]
)

Arguments

  • request_body List[AddClassificationRequestBody]
    • Request body of addClassification method
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ClassificationTemplate.

Returns the updated securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

Update classification

Updates the labels and descriptions of one or more classifications available to the enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

This operation is performed by calling function update_classification.

See the endpoint docs at API Reference.

client.classifications.update_classification(
    [
        UpdateClassificationRequestBody(
            enum_option_key=classification.key,
            data=UpdateClassificationRequestBodyDataField(
                key=updated_classification_name,
                static_config=UpdateClassificationRequestBodyDataStaticConfigField(
                    classification=UpdateClassificationRequestBodyDataStaticConfigClassificationField(
                        color_id=2,
                        classification_definition=updated_classification_description,
                    )
                ),
            ),
        )
    ]
)

Arguments

  • request_body List[UpdateClassificationRequestBody]
    • Request body of updateClassification method
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ClassificationTemplate.

Returns the updated securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

Add initial classifications

When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications.

If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

This operation is performed by calling function create_classification_template.

See the endpoint docs at API Reference.

Currently we don't have an example for calling create_classification_template in integration tests

Arguments

  • scope CreateClassificationTemplateScope
    • The scope in which to create the classifications. This should be enterprise or enterprise_{id} where id is the unique ID of the enterprise.
  • template_key CreateClassificationTemplateTemplateKey
    • Defines the list of metadata templates.
  • display_name CreateClassificationTemplateDisplayName
    • The name of the template as shown in web and mobile interfaces.
  • hidden Optional[bool]
    • Determines if the classification template is hidden or available on web and mobile devices.
  • copy_instance_on_item_copy Optional[bool]
    • Determines if classifications are copied along when the file or folder is copied.
  • fields List[CreateClassificationTemplateFields]
    • The classification template requires exactly one field, which holds all the valid classification values.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ClassificationTemplate.

Returns a new securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.