POST /api/system/permissions/validate

Owned by Team Oktopus
Last updated: Jul 12, 2022 by Technische Redaktion
2 min read
As of Versionproduct version 1.0 | component version 1.0
Request MethodPOST
Response FormatJSON
Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service
DescriptionThis endpoint is used to validate a permissions file to determine its fitness to become the new global permissions file of the yuuvis® system. 
Request HeadersContent-Type: application/xml
Request Example

/api/system/permissions/validate

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<roleSet xmlns="http://optimal-systems.org/ns/dmscloud/roleset/">
    <role>
        <name>ReadDeleteEmail</name>
        <permission>
            <action>read</action>
            <action>delete</action>
            <condition>system:objectTypeId = 'email:email'</condition>
        </permission>
    </role>
    <role>
        <name>ReadDocument</name>
        <permission>
            <action>read</action>
            <condition>system:objectTypeId = 'document'</condition>
        </permission>
    </role>
    <role>
        <name>ReadEmailAndDocument</name>
        <permission>
            <action>read</action>
            <condition>system:objectTypeId in ('email:email', 'document')</condition>
        </permission>
    </role>
    <role>
        <name>DeleteDocument</name>
        <permission>
            <action>delete</action>
            <condition>system:objectTypeId in ('document')</condition>
        </permission>
    </role>
    <role>
        <name>AdminRole</name>
        <permission>
            <action>read</action>
            <action>create</action>
            <action>delete</action>
        </permission>
    </role>
</roleSet>
Response Example

The result is a JSON structure containing a validationErrors list, which could be an empty list.

200 - no validation errors, the role set has been updated
{
    "validationErrors": []
}
422 - there were validation errors, the role set was not updated
{
    "validationErrors": [
        {
            "message": "Unable to unmarshal schema. [line: 14][column: 13] cvc-complex-type.2.4.a: Invalid content was found starting with element 
			'condition'. One of '{\"http://optimal-systems.org/ns/dmscloud/roleset/\":action}' is expected."
        }
    ]
}