Check directory connector health

POST

/api/admin/tenants/{tenantId}/directory-connectors/{connectorId}/health

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/directory-connectors/example/health \
  --header 'Authorization: Bearer <token>'

Calls the configured connector /healthz endpoint for direct transport, or returns relay transport status metadata for outbound relay connectors.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

connectorId

required

string

Responses

200

Directory connector health check result.

Media type application/json

object

ok

required

boolean

connector_id

required

string

status

integer

body

One of:

object

object

ok

required

boolean

connections

required

integer

authenticated_connections

required

integer

pending_requests

required

integer

max_pending_requests

required

integer

>= 1

verify_timeout_ms

required

integer

>= 100

challenge_ttl_ms

required

integer

>= 5000

relay_protocol

required

string

protocol_version

required

integer

>= 1

min_supported_version

required

integer

>= 1

last_connected_at

string format: date-time

last_authenticated_at

string format: date-time

authenticated_key_id

string

last_verify_started_at

string format: date-time

last_verify_succeeded_at

string format: date-time

last_verify_failed_at

string format: date-time

last_disconnect_at

string format: date-time

last_disconnect_reason

string

key

additional properties

object

object

key

additional properties

null

null

error

string

error_description

string

key

additional properties

Example

{
  "ok": true,
  "connector_id": "campus",
  "status": 200,
  "body": {
    "ok": true,
    "connections": 1,
    "authenticated_connections": 1,
    "pending_requests": 0,
    "max_pending_requests": 16,
    "verify_timeout_ms": 5000,
    "challenge_ttl_ms": 30000,
    "relay_protocol": "authrim.wordwarden.relay.v1"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

502

Directory connector health check result.

Media type application/json

object

ok

required

boolean

connector_id

required

string

status

integer

body

One of:

object

object

ok

required

boolean

connections

required

integer

authenticated_connections

required

integer

pending_requests

required

integer

max_pending_requests

required

integer

>= 1

verify_timeout_ms

required

integer

>= 100

challenge_ttl_ms

required

integer

>= 5000

relay_protocol

required

string

protocol_version

required

integer

>= 1

min_supported_version

required

integer

>= 1

last_connected_at

string format: date-time

last_authenticated_at

string format: date-time

authenticated_key_id

string

last_verify_started_at

string format: date-time

last_verify_succeeded_at

string format: date-time

last_verify_failed_at

string format: date-time

last_disconnect_at

string format: date-time

last_disconnect_reason

string

key

additional properties

object

object

key

additional properties

null

null

error

string

error_description

string

key

additional properties

Example

{
  "ok": true,
  "connector_id": "campus",
  "status": 200,
  "body": {
    "ok": true,
    "connections": 1,
    "authenticated_connections": 1,
    "pending_requests": 0,
    "max_pending_requests": 16,
    "verify_timeout_ms": 5000,
    "challenge_ttl_ms": 30000,
    "relay_protocol": "authrim.wordwarden.relay.v1"
  }
}

503

Directory connector health check result.

Media type application/json

object

ok

required

boolean

connector_id

required

string

status

integer

body

One of:

object

object

ok

required

boolean

connections

required

integer

authenticated_connections

required

integer

pending_requests

required

integer

max_pending_requests

required

integer

>= 1

verify_timeout_ms

required

integer

>= 100

challenge_ttl_ms

required

integer

>= 5000

relay_protocol

required

string

protocol_version

required

integer

>= 1

min_supported_version

required

integer

>= 1

last_connected_at

string format: date-time

last_authenticated_at

string format: date-time

authenticated_key_id

string

last_verify_started_at

string format: date-time

last_verify_succeeded_at

string format: date-time

last_verify_failed_at

string format: date-time

last_disconnect_at

string format: date-time

last_disconnect_reason

string

key

additional properties

object

object

key

additional properties

null

null

error

string

error_description

string

key

additional properties

Example

{
  "ok": true,
  "connector_id": "campus",
  "status": 200,
  "body": {
    "ok": true,
    "connections": 1,
    "authenticated_connections": 1,
    "pending_requests": 0,
    "max_pending_requests": 16,
    "verify_timeout_ms": 5000,
    "challenge_ttl_ms": 30000,
    "relay_protocol": "authrim.wordwarden.relay.v1"
  }
}