Access control

Available since Valtimo 12.10.0. Document property conditions available since 12.33.0.

Access to the documents that were uploaded to the case, can be configured through access control. More information about access control can be found in the access control documentation.

com.ritense.resource.authorization.ResourcePermission is deprecated and automatically translated to ZgwDocument on save. Existing configurations continue to work unchanged.

Resources and actions

Resource type	Action	Effect
com.ritense.documentenapi.authorization.ZgwDocument	view_list	Allows viewing the list of documents
	view	Allows downloading a document
	create	Allows uploading a document
	modify	Allows modifying the metadata of a document
	delete	Allows deleting a document

Condition fields

The following fields can be used in field conditions on ZgwDocument:

Field	Type	Description
vertrouwelijkheidaanduiding	String	Confidentiality level (e.g. openbaar, geheim)
status	String	Document status (e.g. definitief, in_bewerking)
informatieobjecttypeUrl	String	URL of the informatieobjecttype
informatieobjecttypeOmschrijving	String	Description of the informatieobjecttype

The document list endpoint does not filter documents by these conditions — all documents for the case are returned. Only single-document operations (view, download, modify, delete) enforce the full conditions.

Examples

Permission to list all documents

{
    "resourceType": "com.ritense.documentenapi.authorization.ZgwDocument",
    "action": "view_list",
    "conditions": []
}

Permission to download only public documents

{
    "resourceType": "com.ritense.documentenapi.authorization.ZgwDocument",
    "action": "view",
    "conditions": [
        {
            "type": "field",
            "field": "vertrouwelijkheidaanduiding",
            "operator": "==",
            "value": "openbaar"
        }
    ]
}

Permission scoped to a case type using a container condition

{
    "resourceType": "com.ritense.documentenapi.authorization.ZgwDocument",
    "actions": ["view_list", "view", "create", "modify", "delete"],
    "conditions": [
        {
            "type": "container",
            "resourceType": "com.ritense.document.domain.impl.JsonSchemaDocument",
            "conditions": [
                {
                    "type": "field",
                    "field": "documentDefinitionId.caseDefinitionId.key",
                    "operator": "in",
                    "value": ["bezwaar"]
                }
            ]
        }
    ]
}