List sign-in methods
Returns the deployment’s available sign-in methods: whether password sign-in is enabled and which OIDC providers are configured. Unauthenticated, so a login screen can render the right buttons before anyone signs in.
curl --request GET \
--url https://api.example.com/capabilities/authimport requests
url = "https://api.example.com/capabilities/auth"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/capabilities/auth', 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/capabilities/auth",
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/capabilities/auth"
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/capabilities/auth")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/capabilities/auth")
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{
"methods": [
"password"
]
}Response
The sign-in methods this deployment offers.
Lets a client render the login screen without probing: one ordered list of
the identity providers a person can sign in with — password, plus exactly
the OIDC providers (google, microsoft, ...) whose apps are configured on
the server. This is pre-authentication reference data, so the endpoint is
unauthenticated.
The sign-in methods this deployment offers.
Lets a client render the login screen without probing: one ordered list of
the identity providers a person can sign in with — password, plus exactly
the OIDC providers (google, microsoft, ...) whose apps are configured on
the server. This is pre-authentication reference data, so the endpoint is
unauthenticated.
The available sign-in methods, in the order a client should present them:
password first, then each configured OIDC provider.
How an account authenticates.
Corresponds to the IDENTITY_PROVIDER PostgreSQL enum. Password [blocked] is a
locally-held Argon2 secret; the rest are external OIDC providers keyed by
the provider's subject claim.
"password"curl --request GET \
--url https://api.example.com/capabilities/authimport requests
url = "https://api.example.com/capabilities/auth"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/capabilities/auth', 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/capabilities/auth",
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/capabilities/auth"
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/capabilities/auth")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/capabilities/auth")
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{
"methods": [
"password"
]
}