Przeglądaj źródła

docs(http_api): updated http docs and mentioned basic auth option

Torkel Ödegaard 10 lat temu
rodzic
commit
567a42a756
1 zmienionych plików z 14 dodań i 1 usunięć
  1. 14 1
      docs/sources/reference/http_api.md

+ 14 - 1
docs/sources/reference/http_api.md

@@ -11,8 +11,21 @@ dashboards, creating users and updating data sources.
 
 ## Authorization
 
+### Tokens
+
 Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or oauth).
 
+### Basic Auth
+
+If basic auth is enabled (it is enabled by default) you can authenticate your HTTP request via
+standard basic auth.
+
+curl example:
+```
+❯curl http://admin:admin@localhost:3000/api/org
+{"id":1,"name":"Main Org."}
+```
+
 ### Create API Token
 
 Open the sidemenu and click the organization dropdown and select the `API Keys` option.
@@ -309,7 +322,7 @@ The above will return the current user.
 
 Switch user context to the given organisation.
 
-### Organisations of the actual User 
+### Organisations of the actual User
 
 `GET /api/user/orgs`