List database users
curl --request GET \
--url https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users \
--header 'Authorization: <authorization>'import requests
url = "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"users": [
{
"username": "<string>",
"acl": "<string>"
}
]
}Database users
List database users
List the database users configured on a deployment instance.
GET
/
v1
/
customer-ldap
/
instances
/
{instanceId}
/
users
List database users
curl --request GET \
--url https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users \
--header 'Authorization: <authorization>'import requests
url = "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.falkordb.cloud/v1/customer-ldap/instances/{instanceId}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"users": [
{
"username": "<string>",
"acl": "<string>"
}
]
}Returns every database user on the instance with its ACL.
This endpoint uses the FalkorDB API host and bearer token authentication. See Database users overview.
Authorization
Path parameters
string
required
ID of the deployment instance.
Query parameters
string
required
Subscription that owns the instance.
Response
object[]
200 OK
{
"users": [
{ "username": "falkordb", "acl": "~* +GRAPH.QUERY +GRAPH.RO_QUERY +INFO +PING" },
{ "username": "analytics", "acl": "~* +GRAPH.RO_QUERY +GRAPH.EXPLAIN +INFO +PING" }
]
}
Errors
Returns401 Unauthorized when the bearer token is missing or expired.⌘I