2016-11-24 03:16:24 -06:00
|
|
|
+++
|
|
|
|
title = "Authentication HTTP API "
|
|
|
|
description = "Grafana Authentication HTTP API"
|
|
|
|
keywords = ["grafana", "http", "documentation", "api", "authentication"]
|
|
|
|
aliases = ["/http_api/authentication/"]
|
|
|
|
type = "docs"
|
|
|
|
[menu.docs]
|
|
|
|
name = "Authentication"
|
|
|
|
parent = "http_api"
|
|
|
|
+++
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:15:09 -06:00
|
|
|
# Authentication API
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:15:09 -06:00
|
|
|
## Tokens
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or oauth).
|
|
|
|
|
2016-02-05 03:15:09 -06:00
|
|
|
## Basic Auth
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
If basic auth is enabled (it is enabled by default) you can authenticate your HTTP request via
|
2016-12-13 02:15:52 -06:00
|
|
|
standard basic auth. Basic auth will also authenticate LDAP users.
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
curl example:
|
|
|
|
```
|
|
|
|
?curl http://admin:admin@localhost:3000/api/org
|
|
|
|
{"id":1,"name":"Main Org."}
|
|
|
|
```
|
|
|
|
|
2016-02-05 03:15:09 -06:00
|
|
|
## Create API Token
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
Open the sidemenu and click the organization dropdown and select the `API Keys` option.
|
|
|
|
|
2016-11-04 14:29:17 -05:00
|
|
|
![](/img/v2/orgdropdown_api_keys.png)
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
You use the token in all requests in the `Authorization` header, like this:
|
|
|
|
|
|
|
|
**Example**:
|
|
|
|
|
|
|
|
GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
2016-02-05 03:15:09 -06:00
|
|
|
The `Authorization` header value should be `Bearer <your api key>`.
|