LBAC for datasources: Docs update HTTP API (#95392)

This commit is contained in:
Eric Leijonmarck 2024-10-25 15:20:36 +01:00 committed by GitHub
parent 94bbc081c8
commit cc1976693b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 66 additions and 22 deletions

View File

@ -47,6 +47,31 @@ Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example response:**
```http
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 131
{
"rules": [
{
"teamId": "1",
"rules": [
"{ service_name=\"bigquery-sync-mysql\" }"
]
},
{
"teamId": "2",
"rules": [
"{ service_name=\"api\" }"
]
}
]
}
```
## Update LBAC rules for a data source
`PUT /api/datasources/:uid/lbac/teams`
@ -72,11 +97,18 @@ Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"teamId": 1,
"rules": [
{
"header": "X-Prom-Label-Policy",
"value": "18042:{ foo=\"bar\" }"
"teamId": "1",
"rules": [
"{ service_name=\"bigquery-sync-mysql\" }"
]
},
{
"teamId": "2",
"rules": [
"{ service_name=\"api\" }"
]
}
]
}
@ -90,20 +122,23 @@ 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": [
"message": "Data source LBAC rules updated",
"name": "loki",
"rules": [
{
"teamId": 1,
"teamId": "1",
"rules": [
{
"header": "X-Prom-Label-Policy",
"value": "18042:{ foo=\"bar\" }"
}
"{ service_name=\"bigquery-sync-mysql\" }"
]
},
{
"teamId": "2",
"rules": [
"{ service_name=\"api\" }"
]
}
]
],
"uid": "ee1nm1t7spog0e",
}
```

View File

@ -10392,15 +10392,18 @@
"type": "integer",
"format": "int64"
},
"lbacRules": {
"$ref": "#/definitions/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
},
"uid": {
"type": "string"
}

View File

@ -24741,15 +24741,18 @@
"type": "integer",
"format": "int64"
},
"lbacRules": {
"$ref": "#/definitions/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
},
"uid": {
"type": "string"
}

View File

@ -2112,15 +2112,18 @@
"format": "int64",
"type": "integer"
},
"lbacRules": {
"$ref": "#/components/schemas/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/TeamLBACRule"
},
"type": "array"
},
"uid": {
"type": "string"
}