[v11.2.x] API Docs: create Authentication page and order sidebar menu (#93019)

API Docs: create `Authentication` page and order sidebar menu (#92900) * API Docs: create `Authentication` page and order sidebar menu * fix minor typos * Update capitalization We don't capitalize titles as per https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/ * Update docs/sources/developers/http_api/examples/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/developers/http_api/authentication.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> --------- Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> (cherry picked from commit e87140bf75) Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2024-09-06 08:46:34 +02:00
parent e199e4f723
commit 62193aeab6
6 changed files with 87 additions and 39 deletions
@@ -0,0 +1,43 @@
+---
+aliases:
+  - ../../../http_api/curl-examples/ # /docs/grafana/<GRAFANA_VERSION>/http_api/curl-examples/
+  - ../../http_api/curl-examples/ # /docs/grafana/<GRAFANA_VERSION>/developers/http_api/curl-examples/
+canonical: /docs/grafana/latest/developers/http_api/examples/curl-examples/
+description: cURL examples
+keywords:
+  - grafana
+  - http
+  - documentation
+  - api
+  - curl
+labels:
+  products:
+    - enterprise
+    - oss
+title: cURL examples
+---
+
+# cURL examples
+
+This page provides examples of calls to the Grafana API using cURL.
+
+The most basic example for a dashboard for which there is no authentication. You can test the following on your local machine, assuming a default installation and anonymous access enabled, required:
+
+```
+curl http://localhost:3000/api/search
+```
+
+Here's a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication]({{< relref "/docs/grafana/latest/setup-grafana/configure-security/configure-authentication#basic-auth" >}}) enabled using the default admin credentials:
+
+```
+curl http://admin:admin@localhost:3000/api/search
+```
+
+To pass a username and password with [HTTP basic authorization]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}), encode them as base64.
+You can't use authorization tokens in the request.
+
+For example, to [list permissions associated with roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}) given a username of `user` and password of `password`, use:
+
+```
+curl --location '<grafana_url>/api/access-control/builtin-roles' --user 'user:password'
+```