From 50bd27b66554b11f6d32b296eff7880ccce88e51 Mon Sep 17 00:00:00 2001 From: bla2ej <123992384+bla2ej@users.noreply.github.com> Date: Fri, 28 Jul 2023 16:03:56 +0200 Subject: [PATCH] API: fix docs of users API (#62365) (#62816) * API: fix docs of users API (#62365) Behaviour described in the issue is correct. So with this we add comment explaining this behaviour. Resolves: #62365 * fixing formating * Update docs/sources/developers/http_api/user.md Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com> --------- Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com> --- docs/sources/developers/http_api/user.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/sources/developers/http_api/user.md b/docs/sources/developers/http_api/user.md index 986f57de26d..75de84a38cb 100644 --- a/docs/sources/developers/http_api/user.md +++ b/docs/sources/developers/http_api/user.md @@ -18,7 +18,13 @@ title: User HTTP API # User API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +The Users HTTP API does not currently work with an API Token. API Tokens are linked to an organization and an organization role. They cannot be given +the permission of server users access, only users can be given that permission. To use these API calls you can use Basic Auth and the Grafana +user must have the Grafana Admin role. + +API Tokens can be used with Organization HTTP API to get users of specific organization. + +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information. ## Search Users