Assign Data Security Rules
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API assigns one or more data security rules to users or groups by creating rule mappings.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/data-security-rules/assign
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the Login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Semantic Model for which data security rules need to be assigned. Note: If the Semantic Model name is provided, then folderName must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or a Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If folderName is not provided, the Semantic Model is treated as a root-level entity by default. | – |
ruleNames | String | Comma-separated list of data security rule names to assign. | – |
groupNames | String | Comma-separated list of groups to which the data security rules are assigned. Note: Either userNames or groupNames must be provided. | – |
userNames | String | Comma-separated list of users to which the data security rules are assigned. | – |
rulesMappingsJson | String | A valid JSON array containing objects with user name, group name, and rule name mappings. Note: An example JSON is provided in the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Data security rule mapping added successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the ruleMappingsJson parameter in the request body.
[
{
"userNames": "admin",
"groupNames": "Group1",
"ruleNames": "Rules1"
}
]