Get public authentication configuration
curl --request GET \
--url https://api.example.com/api/auth/public-configimport requests
url = "https://api.example.com/api/auth/public-config"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/auth/public-config', 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/api/auth/public-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/auth/public-config"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/auth/public-config")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/public-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"oAuthProviders": [
"google"
],
"customOAuthProviders": [
"<string>"
],
"requireEmailVerification": true,
"passwordMinLength": 66,
"requireNumber": true,
"requireLowercase": true,
"requireUppercase": true,
"requireSpecialChar": true,
"verifyEmailMethod": "code",
"resetPasswordMethod": "code",
"disableSignup": true
}Client
Get public authentication configuration
Get all public authentication configuration including OAuth providers and email auth settings (public endpoint)
GET
/
api
/
auth
/
public-config
Get public authentication configuration
curl --request GET \
--url https://api.example.com/api/auth/public-configimport requests
url = "https://api.example.com/api/auth/public-config"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/auth/public-config', 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/api/auth/public-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/auth/public-config"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/auth/public-config")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/public-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"oAuthProviders": [
"google"
],
"customOAuthProviders": [
"<string>"
],
"requireEmailVerification": true,
"passwordMinLength": 66,
"requireNumber": true,
"requireLowercase": true,
"requireUppercase": true,
"requireSpecialChar": true,
"verifyEmailMethod": "code",
"resetPasswordMethod": "code",
"disableSignup": true
}Response
200 - application/json
Public authentication configuration
Available options:
google, github, discord, linkedin, facebook, instagram, tiktok, apple, x, spotify, microsoft Required range:
4 <= x <= 128Method for email verification (code = 6-digit OTP, link = magic link)
Available options:
code, link Method for password reset (code = 6-digit OTP + exchange flow, link = magic link)
Available options:
code, link When true, new user sign-ups are disabled. Existing users can still sign in.
Was this page helpful?