Get Data Security Rule
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API fetches details of a Data Security Rule applied to a Semantic Model using the rule name.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/data-security-rules/{rule-name}
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 |
|---|---|---|---|
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 the Data Security Rule is to be fetched. Note: If the Semantic Model name is provided, then folderName must also be provided. | – |
rule-name (Required) | String | Name of the Data Security Rule to be fetched. | – |
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. | – |
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify Note: If folderName is not provided, the Semantic Model is treated as a root-level entity by default. | – |
Responses
200 Success
{
"rule": {
"name": "Allow All Rows",
"repositDate": 0,
"id": "RULE_ALLOW_ALL_ROWS",
"globalType": 1,
"desc": "This rule specifies that no row level security is applied. The user will be allowed all rows ignoring any other row level security for this user."
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |