Set Session Cookies
curl --request PUT \
--url http://localhost:4000/v2/auth/session \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"refreshToken": "<string>",
"idToken": "<string>",
"checksum": "<string>",
"redirectUrl": "<string>"
}
'import requests
url = "http://localhost:4000/v2/auth/session"
payload = {
"refreshToken": "<string>",
"idToken": "<string>",
"checksum": "<string>",
"redirectUrl": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
refreshToken: '<string>',
idToken: '<string>',
checksum: '<string>',
redirectUrl: '<string>'
})
};
fetch('http://localhost:4000/v2/auth/session', 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 => "4000",
CURLOPT_URL => "http://localhost:4000/v2/auth/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'refreshToken' => '<string>',
'idToken' => '<string>',
'checksum' => '<string>',
'redirectUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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:4000/v2/auth/session"
payload := strings.NewReader("{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("http://localhost:4000/v2/auth/session")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/v2/auth/session")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request - Invalid input"
}{
"success": false,
"errorCode": "UNAUTHORISED",
"message": "Unauthorized - Invalid credentials, token or cookies"
}Authentication
Set Session Cookies
Using a JWT token and a checksum, this endpoint sets session cookies in the user’s browser.
This is typically used in iFrames where a client’s backend generates a JWT Token using its API key, and the backend then asks the end user’s browser to render an iFrame with the JWT Token embedded. The iFrame then calls this endpoint to set the cookies in the browser.
The checksum is computed using HMAC with the tokens as input to ensure the tokens have not been tampered with. If the checksum does not match, an error is thrown indicating that the tokens have been tampered with.
See also the
GET /v2/auth/session endpoint.You can use this endpoint to set the cookies in the iFrame, then redirect the user to the desired page
using the
redirectUrl parameter.PUT
/
v2
/
auth
/
session
Set Session Cookies
curl --request PUT \
--url http://localhost:4000/v2/auth/session \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"refreshToken": "<string>",
"idToken": "<string>",
"checksum": "<string>",
"redirectUrl": "<string>"
}
'import requests
url = "http://localhost:4000/v2/auth/session"
payload = {
"refreshToken": "<string>",
"idToken": "<string>",
"checksum": "<string>",
"redirectUrl": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
refreshToken: '<string>',
idToken: '<string>',
checksum: '<string>',
redirectUrl: '<string>'
})
};
fetch('http://localhost:4000/v2/auth/session', 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 => "4000",
CURLOPT_URL => "http://localhost:4000/v2/auth/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'refreshToken' => '<string>',
'idToken' => '<string>',
'checksum' => '<string>',
'redirectUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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:4000/v2/auth/session"
payload := strings.NewReader("{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("http://localhost:4000/v2/auth/session")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/v2/auth/session")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"refreshToken\": \"<string>\",\n \"idToken\": \"<string>\",\n \"checksum\": \"<string>\",\n \"redirectUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request - Invalid input"
}{
"success": false,
"errorCode": "UNAUTHORISED",
"message": "Unauthorized - Invalid credentials, token or cookies"
}Authorizations
apiKeyAuthbearerAuthsessionIdQuery
Body
application/json
Response
Session validated, and cookies set successfully; no redirectUrl provided.