Sign in

curl --request POST \
  --url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin', 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/user/signin",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "omnistrate_token": "<string>",
  "omnistrate_refresh_token": "<string>"
}

POST

2022-09-01-00

resource-instance

user

signin

curl --request POST \
  --url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin', 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/user/signin",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "omnistrate_token": "<string>",
  "omnistrate_refresh_token": "<string>"
}

Signs the user in. Send the request with HTTP Basic authentication (Authorization: Basic <base64(user:password)>). The response sets two HttpOnly cookies that authorize every other endpoint.

Authorization

string

required

Basic authentication credentials: Basic <base64(username:password)>.

Response

Cookies

string

required

Session JWT. Send it on every subsequent request. Expires after 1 hour (Max-Age=3600).

string

required

Refresh token used to obtain a new session token. Expires after 24 hours (Max-Age=86400).

Both cookies are issued with the following attributes:

200 OK

Set-Cookie: omnistrate_token=eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9...; Path=/; HttpOnly; SameSite=Lax; Max-Age=3600; Domain=.falkordb.cloud; Secure
Set-Cookie: omnistrate_refresh_token=4610...; Path=/; HttpOnly; SameSite=Lax; Max-Age=86400; Domain=.falkordb.cloud; Secure

Attribute	Value	Effect
`HttpOnly`	—	The cookies are not readable from JavaScript.
`Secure`	—	The cookies are only sent over HTTPS.
`SameSite`	`Lax`	The cookies are sent on top-level navigations and same-site requests.
`Domain`	`.falkordb.cloud`	The cookies are scoped to FalkorDB Cloud and its subdomains.
`Path`	`/`	The cookies are sent on every path.

Because the cookies are HttpOnly, your application cannot read or store them itself. Browser clients should send requests with credentials included; server-side and CLI clients should persist and replay the Set-Cookie values.

Browsers attach the cookies automatically as long as the request includes credentials:

await fetch("/api/instances", { credentials: "include" });

Other clients must store the cookies and send them back. With curl, use a cookie jar:

curl -c cookies.txt -X POST \
  https://api.omnistrate.cloud/2022-09-01-00/resource-instance/user/signin \
  -u "$FALKORDB_EMAIL:$FALKORDB_PASSWORD"

curl -b cookies.txt https://api.omnistrate.cloud/...

Session lifetime

The session token is valid for 1 hour. After it expires, use the refresh token to obtain a new session, or sign in again. The refresh token is valid for 24 hours; once it expires, the user must sign in with their credentials.

Errors

Status	Name	Description
400	`bad_request`	The request is malformed.
401	`auth_failure`	The credentials are invalid.
500	`failed_request`	The server failed to complete the sign-in.

Error responses use the application/vnd.goa.error content type:

{
  "name": "bad_request",
  "id": "123abc",
  "message": "parameter 'p' must be an integer",
  "temporary": true,
  "timeout": false,
  "fault": false
}

⌘I

Authentication

Account management

Cloud accounts

Custom networks

Snapshots

Database users

Enterprise BYOA

Enterprise

Pro

Startup

Free

Authorization

Response

Cookies

Session lifetime

Errors

​Authorization

​Response

​Cookies

​Sending the cookie

​Session lifetime

​Errors

Authorization

Response

Cookies

Sending the cookie

Session lifetime

Errors