OpenAPI Specification
openapi: 3.0.3
info:
title: Grafana Dashboard Alerting Users API
description: The Grafana HTTP API provides programmatic access to dashboard management, datasource configuration, organization management, user administration, annotation management, and alerting. Grafana is an open-source observability and analytics platform for infrastructure, application, and business monitoring.
version: 10.0.0
contact:
name: Grafana Labs
url: https://grafana.com/
license:
name: AGPL-3.0
url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: https://{grafana-host}/api
description: Grafana instance API
variables:
grafana-host:
default: localhost:3000
description: Grafana server hostname and port
security:
- BasicAuth: []
- ApiKeyAuth: []
tags:
- name: Users
description: Manage Grafana users
paths:
/org/users:
get:
operationId: listOrgUsers
summary: List Organization Users
description: Get all users in the current organization.
tags:
- Users
responses:
'200':
description: List of users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OrgUserDTO'
components:
schemas:
OrgUserDTO:
type: object
properties:
orgId:
type: integer
userId:
type: integer
email:
type: string
avatarUrl:
type: string
login:
type: string
role:
type: string
enum:
- Viewer
- Editor
- Admin
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: Basic auth with Grafana username and password
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: API key authentication using 'Bearer {api-key}'
externalDocs:
description: Grafana HTTP API Reference
url: https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/