Note
To use a Grafana API with your Amazon Managed Grafana workspace, you must have a valid Grafana
API token. You include this in the Authorization field in the API
request. For information about how to create a token to authenticate your API calls,
see Authenticate with tokens.
Get external
groups
GET /api/teams/:teamId/groupsExample request
GET /api/teams/1/groups HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]Example response
HTTP/1.1 200
Content-Type: application/json
[
{
"orgId": 1,
"teamId": 1,
"groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
}
]Status Codes:
-
200— Ok
-
401— Unauthorized
-
403— Access denied
Add external
group
POST /api/teams/:teamId/groupsExample request
POST /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]
{
"groupId": "cn=editors,ou=groups,dc=grafana,dc=org"
}Example response
HTTP/1.1 200
Content-Type: application/json
{"message":"Group added to Team"}Status Codes:
-
200— Ok
-
400— Group is already added to this team
-
401— Unauthorized
-
403— Permission denied
-
404— Team not found
Remove external
group
DELETE /api/teams/:teamId/groups/:groupIdExample request
DELETE /api/teams/1/groups/cn=editors,ou=groups,dc=grafana,dc=org HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk]Example response
HTTP/1.1 200
Content-Type: application/json
{"message":"Team Group removed"}Status Codes:
-
200— Ok
-
401— Unauthorized
-
403— Permission denied
-
404— Team not found or group not found
