Get perms #

Retrieves the access permissions for a dashboard inside a tenant index.

Returns an error if the dashboard does not exist.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/dashboard/:index/:_id/perms
Method: GET

Javascript #

kuzzle.query({
  controller: 'dashboard-builder/dashboard',
  action: 'getPerms',
  index: '<index>',
  _id: '<dashboard-id>',
});

Arguments #

Arguments	Type	Description
`index`	string	Index name where the dashboard exists.
`_id`	string	Unique identifier of the dashboard.

Response #

The response contains an array of access permissions for the dashboard.

Example Response #

[
  {
    "checked": true,
    "softTenantId": "soft-tenant-1",
    "softTenantName": "Soft Tenant 1"
  },
  {
    "checked": false,
    "softTenantId": "soft-tenant-2",
    "softTenantName": "Soft Tenant 2"
  }
]

Permission Properties #

Arguments	Type	Description
`checked`	boolean	Whether the soft tenant has access to the dashboard.
`softTenantId`	string	ID of the soft tenant.
`softTenantName`	string	Name of the soft tenant.