cURL
curl --request POST \
--url http://sandbox.mintlify.com/api/portal/session \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"uniqueUserId": "titouan.launay@hotmail.com",
"configuration": {
"userDisplay": "Arthur",
"returnUrl": "https://example.com"
}
}
'import requests
url = "http://sandbox.mintlify.com/api/portal/session"
payload = {
"uniqueUserId": "titouan.launay@hotmail.com",
"configuration": {
"userDisplay": "Arthur",
"returnUrl": "https://example.com"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uniqueUserId: 'titouan.launay@hotmail.com',
configuration: {userDisplay: 'Arthur', returnUrl: 'https://example.com'}
})
};
fetch('http://sandbox.mintlify.com/api/portal/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_URL => "http://sandbox.mintlify.com/api/portal/session",
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([
'uniqueUserId' => 'titouan.launay@hotmail.com',
'configuration' => [
'userDisplay' => 'Arthur',
'returnUrl' => 'https://example.com'
]
]),
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://sandbox.mintlify.com/api/portal/session"
payload := strings.NewReader("{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("http://sandbox.mintlify.com/api/portal/session")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://sandbox.mintlify.com/api/portal/session")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"sessionId": "<string>",
"uniqueUserId": "<string>",
"configuration": {
"userDisplay": "<string>",
"returnUrl": "<string>"
}
}{
"error": 123,
"message": "<string>"
}Endpoint Examples
Create User Session
Creates a new session
POST
/
api
/
portal
/
session
cURL
curl --request POST \
--url http://sandbox.mintlify.com/api/portal/session \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"uniqueUserId": "titouan.launay@hotmail.com",
"configuration": {
"userDisplay": "Arthur",
"returnUrl": "https://example.com"
}
}
'import requests
url = "http://sandbox.mintlify.com/api/portal/session"
payload = {
"uniqueUserId": "titouan.launay@hotmail.com",
"configuration": {
"userDisplay": "Arthur",
"returnUrl": "https://example.com"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uniqueUserId: 'titouan.launay@hotmail.com',
configuration: {userDisplay: 'Arthur', returnUrl: 'https://example.com'}
})
};
fetch('http://sandbox.mintlify.com/api/portal/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_URL => "http://sandbox.mintlify.com/api/portal/session",
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([
'uniqueUserId' => 'titouan.launay@hotmail.com',
'configuration' => [
'userDisplay' => 'Arthur',
'returnUrl' => 'https://example.com'
]
]),
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://sandbox.mintlify.com/api/portal/session"
payload := strings.NewReader("{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("http://sandbox.mintlify.com/api/portal/session")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://sandbox.mintlify.com/api/portal/session")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uniqueUserId\": \"titouan.launay@hotmail.com\",\n \"configuration\": {\n \"userDisplay\": \"Arthur\",\n \"returnUrl\": \"https://example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"sessionId": "<string>",
"uniqueUserId": "<string>",
"configuration": {
"userDisplay": "<string>",
"returnUrl": "<string>"
}
}{
"error": 123,
"message": "<string>"
}Authorizations
Body
application/json
Payload to create a new session