PublicApiEntityAccessDto

PublicApiEntityAccessDto
PublicApiEntityAccessDto

Dashboard entity access

JSON Example
{
    "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
    "entityType": "DASHBOARD",
    "id": "768ea4a8d-7c9d-4762-99f7-fe4be6a77908",
    "owner": "owner",
    "private": false,
    "readRoles": [
        {
            "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
            "datasetList": [
                {
                    "constraints": {
                        "constraints": [
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    }
                                ],
                                "operator": "AND",
                                "tags": [
                                    "log-intelligence:search-bar"
                                ]
                            },
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    },
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "test"
                                    }
                                ],
                                "operator": "AND"
                            }
                        ],
                        "operator": "AND"
                    },
                    "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "description": "test_dataset description",
                    "id": "d5a4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "name": "test_dataset",
                    "restrictAutocomplete": false,
                    "restricts": false
                }
            ],
            "description": "test-feature-access-role description",
            "displayName": "test-feature-access-role",
            "featureAccessList": [
                {
                    "allowedActions": [
                        "DISABLED"
                    ],
                    "description": "Webhook Configuration",
                    "name": "CONFIGURATION.WEBHOOK-CONFIGURATION"
                },
                {
                    "allowedActions": [
                        "UPDATE"
                    ],
                    "description": "API Keys",
                    "name": "CONFIGURATION.API-KEYS"
                }
            ],
            "id": "effa4a8d-7c9d-4762-99f7-fe4be6a9802f",
            "name": "test-feature-access-role"
        }
    ],
    "requesterRoles": [
        {
            "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
            "datasetList": [
                {
                    "constraints": {
                        "constraints": [
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    }
                                ],
                                "operator": "AND",
                                "tags": [
                                    "log-intelligence:search-bar"
                                ]
                            },
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    },
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "test"
                                    }
                                ],
                                "operator": "AND"
                            }
                        ],
                        "operator": "AND"
                    },
                    "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "description": "test_dataset description",
                    "id": "d5a4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "name": "test_dataset",
                    "restrictAutocomplete": false,
                    "restricts": false
                }
            ],
            "description": "test-feature-access-role description",
            "displayName": "test-feature-access-role",
            "featureAccessList": [
                {
                    "allowedActions": [
                        "DISABLED"
                    ],
                    "description": "Webhook Configuration",
                    "name": "CONFIGURATION.WEBHOOK-CONFIGURATION"
                },
                {
                    "allowedActions": [
                        "UPDATE"
                    ],
                    "description": "API Keys",
                    "name": "CONFIGURATION.API-KEYS"
                }
            ],
            "id": "effa4a8d-7c9d-4762-99f7-fe4be6a9802f",
            "name": "test-feature-access-role"
        }
    ],
    "updateRoles": [
        {
            "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
            "datasetList": [
                {
                    "constraints": {
                        "constraints": [
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    }
                                ],
                                "operator": "AND",
                                "tags": [
                                    "log-intelligence:search-bar"
                                ]
                            },
                            {
                                "constraints": [
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "error"
                                    },
                                    {
                                        "fieldName": "text",
                                        "operator": "CONTAINS",
                                        "value": "test"
                                    }
                                ],
                                "operator": "AND"
                            }
                        ],
                        "operator": "AND"
                    },
                    "cspOrgId": "678ea4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "description": "test_dataset description",
                    "id": "d5a4a8d-7c9d-4762-99f7-fe4be6a77908",
                    "name": "test_dataset",
                    "restrictAutocomplete": false,
                    "restricts": false
                }
            ],
            "description": "test-feature-access-role description",
            "displayName": "test-feature-access-role",
            "featureAccessList": [
                {
                    "allowedActions": [
                        "UPDATE"
                    ],
                    "description": "Webhook Configuration",
                    "name": "CONFIGURATION.WEBHOOK-CONFIGURATION"
                },
                {
                    "allowedActions": [
                        "UPDATE"
                    ],
                    "description": "API Keys",
                    "name": "CONFIGURATION.API-KEYS"
                }
            ],
            "id": "effa4a8d-7c9d-4762-99f7-fe4be6a9802f",
            "name": "test-feature-access-role"
        }
    ]
}
string
id
Required

A unique entity access identifier.

string
entityType
Optional

All allowed entity types (QUERY, ALERT,DASHBOARD, INGESTION, EVENT_FORWARDING, METRIC_EXTRACTION, EXTRACTED_FIELD)

Possible values are : QUERY, ALERT, DASHBOARD, INGESTION, EVENT_FORWARDING, METRIC_EXTRACTION, EXTRACTED_FIELD,
string
cspOrgId
Optional

Unique ID associated with the org

string
owner
Optional

Name of the owner of this entity

readRoles
Required

Set of feature access read roles for given entity

updateRoles
Required

Set of feature access update roles for given entity

requesterRoles
Optional

Set of feature access requester roles for given entity

boolean
private
Required

It represents whether the dashboard is private (dashboards that are accessible/visible to the user who created it)