EQTY LabDocs

Authenticated health check for IDP actions

Health check requiring an API secret that confirms IDP reachability by fetching JWKS, so callers (IDP actions/webhooks) know the upstream provider is responsive before invoking other endpoints

gethttps://localhost:8080/health/auth
bash
curl --request GET \
  --url 'https://localhost:8080/health/auth' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:8080/health/auth", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface HealthCheckIDPResponse {
  auth?: string;
  service?: string;
  status?: string;
  timestamp?: string;
  version?: string;
}

const response = await fetch("https://localhost:8080/health/auth", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: HealthCheckIDPResponse = await response.json();
python
import requests

response = requests.get(
    "https://localhost:8080/health/auth",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:8080/health/auth", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/health/auth"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:8080/health/auth");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/health/auth');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/health/auth")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:8080/health/auth")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Parameters

Header parameters

NameTypeDescription
Authorization
required
string

Bearer {api_secret}

Responses

200Health status with IDP verified

application/json
  • authstring
  • servicestring
  • statusstring
  • timestampstring<date-time>
  • versionstring
Examplejson
{
  "auth": "verified",
  "service": "auth-service",
  "status": "healthy",
  "timestamp": "2025-01-01T00:00:00Z",
  "version": "1.0.0"
}

401Unauthorized - Invalid API secret

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

503IDP provider unreachable

application/json
  • authstring
  • servicestring
  • statusstring
  • timestampstring<date-time>
  • versionstring
Examplejson
{
  "auth": "verified",
  "service": "auth-service",
  "status": "healthy",
  "timestamp": "2025-01-01T00:00:00Z",
  "version": "1.0.0"
}