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>
This commit is contained in:
bla2ej 2023-07-28 16:03:56 +02:00 committed by GitHub
parent 4c7b97cdb0
commit 50bd27b665
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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