Grafana

Grafana Users API

User management

GitHub OpenAPI

Operations 5

POST /admin/users Create a new user (admin) #
GET /users Search users #
GET /users/{id} Get user by ID #
PUT /users/{id} Update user #
GET /user Get current user #

Documentation

📖
Documentation
https://grafana.com/docs/grafana/latest/developers/http_api/
📖
Authentication
https://grafana.com/docs/grafana/latest/administration/service-accounts/
📖
GettingStarted
https://grafana.com/docs/grafana/latest/getting-started/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/grafana/refs/heads/main/openapi/grafana-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/grafana/refs/heads/main/json-schema/dashboard.json

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/grafana/refs/heads/main/graphql/grafana-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/grafana-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

grafana-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Grafana HTTP Users API
  description: The Grafana HTTP API provides programmatic access to Grafana's core functionality including dashboards, data sources, alerts, users, organizations, folders, annotations, and teams. Authentication is handled via API keys, basic auth, or OAuth tokens passed in the Authorization header.
  version: 11.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://{instance}.grafana.net/api
  description: Grafana Cloud
  variables:
    instance:
      default: your-instance
- url: http://localhost:3000/api
  description: Local Grafana instance
security:
- BearerAuth: []
- BasicAuth: []
- ApiKeyAuth: []
tags:
- name: Users
  description: User management
paths:
  /admin/users:
    post:
      tags:
      - Users
      operationId: adminCreateUser
      summary: Create a new user (admin)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserCommand'
      responses:
        '200':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserResponse'
  /users:
    get:
      tags:
      - Users
      operationId: searchUsers
      summary: Search users
      parameters:
      - name: perpage
        in: query
        schema:
          type: integer
          default: 1000
      - name: page
        in: query
        schema:
          type: integer
          default: 1
      - name: query
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Users found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSearchHit'
  /users/{id}:
    get:
      tags:
      - Users
      operationId: getUserById
      summary: Get user by ID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
    put:
      tags:
      - Users
      operationId: updateUser
      summary: Update user
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserCommand'
      responses:
        '200':
          description: User updated
  /user:
    get:
      tags:
      - Users
      operationId: getCurrentUser
      summary: Get current user
      responses:
        '200':
          description: Current user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
components:
  schemas:
    CreateUserCommand:
      type: object
      required:
      - login
      - password
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        login:
          type: string
        password:
          type: string
        OrgId:
          type: integer
    User:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
          format: email
        name:
          type: string
        login:
          type: string
        theme:
          type: string
        orgId:
          type: integer
        isGrafanaAdmin:
          type: boolean
        isDisabled:
          type: boolean
        isExternal:
          type: boolean
        authLabels:
          type: array
          items:
            type: string
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        avatarUrl:
          type: string
    CreateUserResponse:
      type: object
      properties:
        id:
          type: integer
        message:
          type: string
    UpdateUserCommand:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        login:
          type: string
        theme:
          type: string
    UserSearchHit:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        login:
          type: string
        email:
          type: string
        avatarUrl:
          type: string
        isAdmin:
          type: boolean
        isDisabled:
          type: boolean
        lastSeenAt:
          type: string
          format: date-time
        lastSeenAtAge:
          type: string
        authLabels:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Service account token or API key
    BasicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Format: Bearer <api-key>'