Skip to main content
ZStack
Infrastructure/Federation & SSO

CheckZIAMStatus

Check whether the configured ZIAM service is deployed and ready for SSO configuration.

GET/api/v1/sso/ziam/status

Operation ID

CheckZIAMStatus

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • service
    String

    Service name returned by ZIAM health/version endpoints.

    Example: ziam

  • endpoint
    String

    Configured ZIAM endpoint checked by federation.

    Example: http://ziam:8082

  • ready
    Boolean

    Whether ZIAM reports ready.

    Example: true

  • status
    String

    Raw status returned by ZIAM health endpoint.

    Example: ok

  • version
    String

    ZIAM version string, when available.

    Example: 1.2.0

  • commit
    String

    ZIAM git commit string, when available.

    Example: abcdef1

  • checks
    LinkedHashMap

    Per-dependency health checks returned by ZIAM.

    Example: (nested object)

  • errorMessage
    String

    Error message when the check failed or ZIAM is not ready.

    Example: db unreachable

  • checkedAt
    String

    Time when federation checked ZIAM readiness.

    Example: 2026-01-15T08:00:00Z