Authenticated health check for IDP actions

GET

/health/auth

const url = 'https://localhost:8080/health/auth';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:8080/health/auth

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

Responses

200

Health status with IDP verified

application/json

object

auth

string

service

string

status

string

timestamp

string

version

string

Example

{
  "auth": "verified",
  "service": "auth-service",
  "status": "healthy",
  "version": "1.0.0"
}

401

Unauthorized - Invalid API secret

application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

503

IDP provider unreachable

application/json

object

auth

string

service

string

status

string

timestamp

string

version

string

Example

{
  "auth": "verified",
  "service": "auth-service",
  "status": "healthy",
  "version": "1.0.0"
}