Skip to main content
API Explorer|API Explorer
Infrastructure/Federation & SSO
GETFederationSince 1.0SynchronousAuth Required

ListFederationStatus

List federation status records showing which platforms have received SSO configs.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • tenantUuidString

    Deprecated and ignored. Federation status is global.

  • limitInteger

    Maximum number of federation status records to return per page.

    Example: 0

  • offsetInteger

    Zero-based offset for paginating through federation status records.

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • platformUuidString

      UUID of the federated platform.

      Example: platform-abc123

    • platformNameString

      Human-readable name of the federated platform.

      Example: prod-cloud-01

    • productTypeString

      Product type of the federated platform.

      Example: zstack

    • statusString

      Current federation status for this platform.

      Example: federated

    • healthStatusString

      Health status of the SSO integration on this platform.

      Example: healthy

    • federationObject

      Federation for this resource

      • uuidString

        Unique identifier of this federation record.

        Example: fed-001

      • ssoConfigUuidString

        UUID of the SSO configuration that was federated.

        Example: sso-cfg-001

      • platformUuidString

        UUID of the target platform to which the SSO config was pushed.

        Example: platform-abc123

      • productTypeString

        Product type of the target platform receiving the federation.

        Example: zstack

      • ssoClientUuidString

        Client UUID assigned by the target platform after successful federation.

        Example: client-xyz

      • callbackUrlString

        Callback URL registered on the target platform for this federation.

        Example: https://platform.example.com/sso/callback

      • metadataString

        Additional metadata associated with this federation record.

        Example: {}

      • statusString

        Current status of the federation operation.

        Example: success

      • errorMessageString

        Error message if the federation operation failed.

        Example: authentication failed

      • federatedAtString

        Federated at

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

      • updatedAtString

        Updated at

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

      • ssoConfigNameString

        Display name of the SSO configuration that was federated to this platform.

        Example: Corporate SSO

  • totalInteger

    Total number of platform federation status records available.

    Example: 3

  • limitInteger

    Maximum number of items returned in this page.

    Example: 20

  • offsetInteger

    Zero-based offset of the first item in this page.

    Example: 20

Endpoint

GET/api/v1/sso/federations

/api/v1/sso/federations

Operation ID

ListFederationStatus

Permalink

Request Example

curl -X GET '{host}/api/v1/sso/federations' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 3,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history