Sign in to the application

curl --request POST \
  --url https://api.example.com/v2/databases/{database}/auth/signin \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "yourpassword"
}
'

import requests

url = "https://api.example.com/v2/databases/{database}/auth/signin"

payload = {
    "email": "user@example.com",
    "password": "yourpassword"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'user@example.com', password: 'yourpassword'})
};

fetch('https://api.example.com/v2/databases/{database}/auth/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.example.com/v2/databases/{database}/auth/signin",
  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' => 'user@example.com',
    'password' => 'yourpassword'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v2/databases/{database}/auth/signin"

	payload := strings.NewReader("{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.example.com/v2/databases/{database}/auth/signin")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/auth/signin")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}"

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

{
  "user": {
    "name": "User Name",
    "email": "user@example.com",
    "image": "https://example.com/user.png"
  }
}

{
  "error": "Unauthorized"
}

POST

databases

{database}

auth

signin

curl --request POST \
  --url https://api.example.com/v2/databases/{database}/auth/signin \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "yourpassword"
}
'

import requests

url = "https://api.example.com/v2/databases/{database}/auth/signin"

payload = {
    "email": "user@example.com",
    "password": "yourpassword"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'user@example.com', password: 'yourpassword'})
};

fetch('https://api.example.com/v2/databases/{database}/auth/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.example.com/v2/databases/{database}/auth/signin",
  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' => 'user@example.com',
    'password' => 'yourpassword'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v2/databases/{database}/auth/signin"

	payload := strings.NewReader("{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.example.com/v2/databases/{database}/auth/signin")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/auth/signin")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@example.com\",\n  \"password\": \"yourpassword\"\n}"

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

{
  "user": {
    "name": "User Name",
    "email": "user@example.com",
    "image": "https://example.com/user.png"
  }
}

{
  "error": "Unauthorized"
}

Path Parameters

database

string

required

The string (id or name, depending on the credentials)

Body

application/json

string<email>

required

Example:

"user@example.com"

password

string<password>

required

Example:

"yourpassword"

Response

Successful authentication

user

object

Show child attributes

auth

users

tenants

Path Parameters

Body

Response