Authenticated health check for the auth integration

GET

/health/auth

const url = 'https://localhost:10001/health/auth';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

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:10001/health/auth \
  --header 'Authorization: <Authorization>'

Health check requiring a valid bearer token that confirms the end-to-end auth path by validating the token through the auth service and resolving the caller’s user context

Authorizations

BearerAuth

Responses

200

Auth integration verified

application/json

Status of the governance service’s connection to the auth service

object

auth

string

service

string

status

string

timestamp

string format: date-time

version

string

Example

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

401

Unauthorized - Invalid or expired token

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

503

Auth integration unavailable

application/json

Status of the governance service’s connection to the auth service

object

auth

string

service

string

status

string

timestamp

string format: date-time

version

string

Example

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