6ee7f7dc79
* Add: http docs for lbac for datasources * spelling * update with only cloud loki * rename to lbac for datasources * moved it * Update _index.md This commit fixes minor style and punctuation issus * change datasource to data source * replace datasource with data source minor updates and style fixes * minor style changes * prettier --------- Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
3.0 KiB
| aliases | canonical | description | keywords | labels | title | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
/docs/grafana/latest/developers/http_api/datasource_lbac_rules/ | Data Source LBAC rules API |
|
|
Datasource LBAC rules HTTP API |
Data Source LBAC rules API
The Data Source LBAC rules are only available in Grafana Cloud. Only cloud loki data sources are supported.
LBAC (Label-Based Access Control) rules can be set for teams.
Get LBAC rules for a data source
GET /api/datasources/:uid/lbac/teams
Gets all existing LBAC rules for the data source with the given uid.
Required permissions
| Action | Scope |
|---|---|
| datasources:read | datasources: datasources:uid: datasources:uid:my_datasource (single data source) |
Examples
Example request:
GET /api/datasources/:uid/lbac/teams HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Update LBAC rules for a data source
PUT /api/datasources/:uid/lbac/teams
Updates LBAC rules for teams associated with the data source with the given uid. Here you submit a list of teams and the rules for each team.
Deleting a team from the list will remove the team's LBAC rules. You have to submit all teams and their rules to be updated, to remove a team's rules, you have to submit the current list of rules without the team.
Required permissions
| Action | Scope |
|---|---|
| datasources:write | datasources: datasources:uid: datasources:uid:my_datasource (single data source) |
| datasources.permissions:write | datasources: datasources:uid: datasources:uid:my_datasource (single data source) |
Examples
Example request:
PUT /api/datasources/my_datasource/lbac/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"teamId": 1,
"rules": [
{
"header": "X-Prom-Label-Policy",
"value": "18042:{ foo=\"bar\" }"
}
]
}
Example response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35
{
"message": "Data source LBAC rules updated",
"id": 1,
"uid": "my_datasource",
"name": "My Data Source",
"lbacRules": [
{
"teamId": 1,
"rules": [
{
"header": "X-Prom-Label-Policy",
"value": "18042:{ foo=\"bar\" }"
}
]
}
]
}