Category / Section
How to provide user permission for dashboard and other entities using Bold BI REST API
Published:
This article explains how to provide user or group permission to create, read, write or delete dashboards, data sources, schedules, slideshow, or category.
Endpoint
| Method | URL | |
|---|---|---|
| User Permission | POST | v4.0/permissions/users |
| Group Permission | POST | v4.0/permissions/groups |
Authorization
All REST API endpoints are protected using OAuth 2.0. To access this API, you need to get an access token and pass the authorization in the request header. To get the authorized token, refer to the following help documents:
| Header Name | Header Value |
|---|---|
| Authorization | Bearer <authentication_token> |
- The API will accept content types - application/json or application/x-www-form-urlencoded
Request body
Refer the below parameter details
| Parameter | Type | Mandatory Field | Details |
|---|---|---|---|
| PermissionAccess | String | Yes | Specify an access type for item. |
| PermissionEntity | String | Yes | Specify an entity of item for permission. |
| UserId | Integer | Yes | User ID |
| ItemId | Nullable guid as string | No | Specify the item ID while assigning permission to particular item. ItemId should be provided if any of below permission entities are provided, SpecificCategory, SpecificDashboard, SpecificDataSource, SpecificSchedule, SpecificSlideshow, DashboardsInCategory |
In below case we have sent an API request to provide data source create permission to user. Refer the sample request and response below.
Note:
- For group permission provide the request body GroupId instead of UserId
- Bold BI Embedded Analytics Server:To check the status of a Bold BI Embedded Analytics Server tenant site, use the following API endpoint: {domain_name}/bi/api/site/{site_identifier}/v4.0/permissions/users
Replace{domain_name}with your server’s domain name and{site_identifier}with the unique identifier of the site you want to check. In the below URL site1 is the site identifier of the site
http://localhost/bi/site/site1 - Bold BI Cloud Analytics Server:To check the status of a Bold BI Cloud Analytics Server tenant site, use the following API endpoint: {domain_name}/bi/api/v4.0/permissions/users Replace
{domain_name}with your server’s domain name.
Related Links:
IJ
