List sign-in methods - Nvisy

GET

/

capabilities

/

auth

List sign-in methods

curl --request GET \
  --url https://api.example.com/capabilities/auth

<?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))

}

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

200 - application/json

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.

methods

string[]

required

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.

Allowed value: "password"

List sign-in methods

curl --request GET \
  --url https://api.example.com/capabilities/auth

<?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))

}

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"
  ]
}