Authenticate user by username(email) and password
curl --request POST \
--url https://{host}/frontend/api/v1/auth/sign-in \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"current-user": "jsmith@example.com",
"logout-other": false,
"long-term-token": true,
"password": "<string>",
"ret-url": "<string>"
}
'import requests
url = "https://{host}/frontend/api/v1/auth/sign-in"
payload = {
"email": "jsmith@example.com",
"current-user": "jsmith@example.com",
"logout-other": False,
"long-term-token": True,
"password": "<string>",
"ret-url": "<string>"
}
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: 'jsmith@example.com',
'current-user': 'jsmith@example.com',
'logout-other': false,
'long-term-token': true,
password: '<string>',
'ret-url': '<string>'
})
};
fetch('https://{host}/frontend/api/v1/auth/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_URL => "https://{host}/frontend/api/v1/auth/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([
'email' => 'jsmith@example.com',
'current-user' => 'jsmith@example.com',
'logout-other' => false,
'long-term-token' => true,
'password' => '<string>',
'ret-url' => '<string>'
]),
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://{host}/frontend/api/v1/auth/sign-in"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\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://{host}/frontend/api/v1/auth/sign-in")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/frontend/api/v1/auth/sign-in")
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\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"api-token": "<string>",
"current-user": "<string>",
"email": "<string>",
"jwt-token": {
"expire": "2023-11-07T05:31:56Z",
"token": "<string>"
},
"oauth-provider-tokens": [
{
"provider": "<string>",
"token": "<string>"
}
],
"ret-url": "<string>",
"user-id": 1
}Auth
Authenticate user by username(email) and password
POST
/
frontend
/
api
/
v1
/
auth
/
sign-in
Authenticate user by username(email) and password
curl --request POST \
--url https://{host}/frontend/api/v1/auth/sign-in \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"current-user": "jsmith@example.com",
"logout-other": false,
"long-term-token": true,
"password": "<string>",
"ret-url": "<string>"
}
'import requests
url = "https://{host}/frontend/api/v1/auth/sign-in"
payload = {
"email": "jsmith@example.com",
"current-user": "jsmith@example.com",
"logout-other": False,
"long-term-token": True,
"password": "<string>",
"ret-url": "<string>"
}
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: 'jsmith@example.com',
'current-user': 'jsmith@example.com',
'logout-other': false,
'long-term-token': true,
password: '<string>',
'ret-url': '<string>'
})
};
fetch('https://{host}/frontend/api/v1/auth/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_URL => "https://{host}/frontend/api/v1/auth/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([
'email' => 'jsmith@example.com',
'current-user' => 'jsmith@example.com',
'logout-other' => false,
'long-term-token' => true,
'password' => '<string>',
'ret-url' => '<string>'
]),
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://{host}/frontend/api/v1/auth/sign-in"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\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://{host}/frontend/api/v1/auth/sign-in")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/frontend/api/v1/auth/sign-in")
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\": \"jsmith@example.com\",\n \"current-user\": \"jsmith@example.com\",\n \"logout-other\": false,\n \"long-term-token\": true,\n \"password\": \"<string>\",\n \"ret-url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"api-token": "<string>",
"current-user": "<string>",
"email": "<string>",
"jwt-token": {
"expire": "2023-11-07T05:31:56Z",
"token": "<string>"
},
"oauth-provider-tokens": [
{
"provider": "<string>",
"token": "<string>"
}
],
"ret-url": "<string>",
"user-id": 1
}Body
application/jsonapplication/x-www-form-urlencoded
Required string length:
5 - 255Currently logged in user email
Invalidate other sessions
Expire JWT token in 2 weeks if true and in 3 hours if false
Required string length:
6 - 72Login return URL
Response
200 - application/json
OK
Example:
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
anonymous, pending, active, suspended Required range:
x >= 0Was this page helpful?
⌘I

