Dashboards

APIs related to dashboards, which will be used to register and get the BI dashboards.

📄️ List user-accessible dashboards

Returns a paginated list of dashboards the authenticated user can access with AccessType owner, editor, or read-only. A valid role_id header is required for authorization (list itself does not require a dashboards.* role permission beyond role membership). Supports filtering, sorting, and field projection.

📄️ Create a dashboard

Registers a new dashboard with metadata and optional widgets. A valid role_id with dashboards.fullaccess is required. On success the creator is granted AccessType owner, and the response includes DashboardId (UUID), CustomUrlPath ({CurrentSlug}-{CustomId}, for example SalesOverview-3c4d5e6f), and a success Message. DashboardId is generated server-side when omitted from the body.

📄️ Get dashboard details

Returns details for a dashboard identified by DashboardId UUID or CustomUrlPath value of the form {CurrentSlug}-{CustomId} (for example SalesOverview-3c4d5e6f). Caller must have at least read-only resource access (AUTH-1012 otherwise).

📄️ Update dashboard details

Updates dashboard metadata and widgets. Caller needs dashboards.manage on role_id and at least editor AccessType on the dashboard. Widgets is required. On success returns Message 'Successfully updated dashboard metadata' with DashboardId and CustomUrlPath ({CurrentSlug}-{CustomId}, for example SalesOverview-3c4d5e6f). Renaming updates CurrentSlug/CustomUrlPath.

📄️ Delete a dashboard

Removes the dashboard from the application. Caller must hold dashboards.fullaccess on role_id and owner AccessType on the dashboard. On success Message is 'Successfully deleted dashboard'. May revoke QuickSight widget access and clean related ACL/notification metadata.