Invite user
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"email": "<string>",
"roleType": "<string>"
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user"
payload = {
"email": "<string>",
"roleType": "<string>"
}
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', roleType: '<string>'})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user', 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.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'roleType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <cookie>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<cookie>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAccess control
Invite user
Grant a user access to a subscription.
POST
/
2022-09-01-00
/
resource-instance
/
subscription
/
{subscriptionId}
/
invite-user
Invite user
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"email": "<string>",
"roleType": "<string>"
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user"
payload = {
"email": "<string>",
"roleType": "<string>"
}
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', roleType: '<string>'})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user', 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.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'roleType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <cookie>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<cookie>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"roleType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyInvites a user to a subscription with the role you specify. Only the subscription owner (
root role) can invite users. If the invitee does not have a FalkorDB Cloud account yet, they receive an invitation email.
Authorization
Path parameters
string
required
The subscription ID, for example
sub-abc123.Body
string
required
Email address of the user to invite.
string
required
Role to grant. One of
root, admin, editor, reader, service_editor, service_reader, or service_operator. Use lowercase values.Request
{
"email": "[email protected]",
"roleType": "editor"
}
Roles
| Role | Access |
|---|---|
reader | Read-only access to deployment instances in the subscription. |
editor | Create, update, and delete deployment instances in the subscription. |
admin | Manage the subscription, including inviting and removing users. |
root | The subscription owner. Assigned automatically at subscription creation. |
Response
Returns200 OK with an empty body.
Errors
See Error for the error response shape.⌘I