Save Data Security Rules Mapping

Resources

Below is an example of JSON structure which can be used as a reference for the rulesMappingJson parameter in the request body.

{
    "rulesMappings":[
        {
            "appDetails":[
                {
                    "name":"amit.thakur",
                    "id":"397039469",
                    "type":"USER"
                }
            ],
            "rules":[
                {
                    "name":"Allow All Rows",
                    "id":"RULE_ALLOW_ALL_ROWS"
                },
                {
                    "name":"Allow All Columns",
                    "id":"RULE_ALLOW_ALL_COLUMNS"
                }
            ],
            "id":"RULES_MAPPING_17754804489725127050095140091501"
        },
        {
            "appDetails":[
                {
                    "name":"new-group-amit",
                    "id":"12345",
                    "type":"GROUP"
                }
            ],
            "rules":[
                {
                    "name":"New-rule",
                    "id":"RULE_17754804815658127093067137855675"
                }
            ],
            "id":"RULES_MAPPING_17778795583625127078021163972300"
        },
        {
            "appDetails":[
                {
                    "name":"Automation_2 20260320223405",
                    "id":"17740316239148127070068122854696",
                    "type":"GROUP"
                }
            ],
            "rules":[
                {
                    "name":"Allow All Rows",
                    "id":"RULE_ALLOW_ALL_ROWS"
                },
                {
                    "name":"Allow All Columns",
                    "id":"RULE_ALLOW_ALL_COLUMNS"
                }
            ],
            "id":"RULES_MAPPING_17754802858081127038063175990243"
        },
        {
            "appDetails":[
                {
                    "name":"anshika.chhirolya",
                    "id":"409021709",
                    "type":"USER"
                }
            ],
            "rules":[
                {
                    "name":"Allow All Rows",
                    "id":"RULE_ALLOW_ALL_ROWS"
                },
                {
                    "name":"Allow All Columns",
                    "id":"RULE_ALLOW_ALL_COLUMNS"
                }
            ],
            "id":"RULES_MAPPING_17792621944592127068045144683383"
        }
    ]
}

JSON Fields Description

Field	Type	Description	Possible Values	Example
rulesMappings	Array	Root array containing data security rules mapping definitions. Each mapping assigns security rules to users or groups	Array of RulesMapping objects	[{...}]
rulesMappings[].id	String	Unique identifier for this rules mapping entry. Auto-generated if not provided	GUID	"RULES_MAPPING_17764122062715"
rulesMappings[].appDetails	Array	Array of user or group details to which the security rules are assigned. Defines WHO gets the security rules	Array of AppDetail objects	[{...}]
rulesMappings[].appDetails[].id	String	Unique identifier of the user or group. This is the system-generated ID for the user/group in Kyvos	User/Group GUID	"user_17764122062715"
rulesMappings[].appDetails[].type	String	Type of the entity - whether it's a user or a group	"USER","GROUP"	"USER"
rulesMappings[].appDetails[].name	String	Display name of the user or group. Used for identification and display purposes in UI	User/Group name	"john.doe"
rulesMappings[].rules	Array	Array of data security rules assigned to the users/groups in appDetails. Defines WHICH rules are applied	Array of Rule objects	[{...}]
rulesMappings[].rules[].id	String	Unique identifier of the data security rule being assigned. Must reference an existing rule created via Save Data Security Rules API	Rule GUID	"rule_17764122062715"
rulesMappings[].rules[].name	String	Display name of the data security rule. Optional - used for reference and display purposes	Rule name	"Sales Region Access Rule"