Sign in with local authentication
curl --request POST \
--url http://localhost:8080/api/v1/auth/local/sign-in \
--header 'Content-Type: application/json' \
--data '
{
"organization": "<string>",
"email": "operator@example.invalid",
"password": "correct-horse-placeholder"
}
'import requests
url = "http://localhost:8080/api/v1/auth/local/sign-in"
payload = {
"organization": "<string>",
"email": "operator@example.invalid",
"password": "correct-horse-placeholder"
}
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({
organization: '<string>',
email: 'operator@example.invalid',
password: 'correct-horse-placeholder'
})
};
fetch('http://localhost:8080/api/v1/auth/local/sign-in', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/auth/local/sign-in",
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([
'organization' => '<string>',
'email' => 'operator@example.invalid',
'password' => 'correct-horse-placeholder'
]),
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 := "http://localhost:8080/api/v1/auth/local/sign-in"
payload := strings.NewReader("{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\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("http://localhost:8080/api/v1/auth/local/sign-in")
.header("Content-Type", "application/json")
.body("{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/auth/local/sign-in")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\n}"
response = http.request(request)
puts response.read_body{
"signedIn": true
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Authentication
Sign in with local authentication
POST
/
api
/
v1
/
auth
/
local
/
sign-in
Sign in with local authentication
curl --request POST \
--url http://localhost:8080/api/v1/auth/local/sign-in \
--header 'Content-Type: application/json' \
--data '
{
"organization": "<string>",
"email": "operator@example.invalid",
"password": "correct-horse-placeholder"
}
'import requests
url = "http://localhost:8080/api/v1/auth/local/sign-in"
payload = {
"organization": "<string>",
"email": "operator@example.invalid",
"password": "correct-horse-placeholder"
}
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({
organization: '<string>',
email: 'operator@example.invalid',
password: 'correct-horse-placeholder'
})
};
fetch('http://localhost:8080/api/v1/auth/local/sign-in', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/auth/local/sign-in",
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([
'organization' => '<string>',
'email' => 'operator@example.invalid',
'password' => 'correct-horse-placeholder'
]),
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 := "http://localhost:8080/api/v1/auth/local/sign-in"
payload := strings.NewReader("{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\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("http://localhost:8080/api/v1/auth/local/sign-in")
.header("Content-Type", "application/json")
.body("{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/auth/local/sign-in")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization\": \"<string>\",\n \"email\": \"operator@example.invalid\",\n \"password\": \"correct-horse-placeholder\"\n}"
response = http.request(request)
puts response.read_body{
"signedIn": true
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}{
"error": "the selected Organization is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Body
application/json
Required string length:
1 - 63Pattern:
^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$Maximum string length:
254Example:
"operator@example.invalid"
Required string length:
12 - 1024Example:
"correct-horse-placeholder"
Response
Sign-in succeeded and the session cookie was issued.