跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/联邦与 SSO
GETFederation起始版本 1.0同步需要认证

查询联邦状态列表

记录显示平台已接收SSO配置。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • tenantUuidString

    租户UUID。

  • limitInteger

    最多返回的记录数。

    示例： 0

  • offsetInteger

    查询起始偏移量。

    示例： 0

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • itemsList

    条目列表。

    示例： (nested array)

    • platformUuidString

      平台UUID。

      示例： platform-abc123

    • platformNameString

      平台名称。

      示例： prod-cloud-01

    • productTypeString

      产品类型。

      示例： zstack

    • statusString

      状态信息。

      示例： federated

    • healthStatusString

      健康度状态。

      示例： healthy

    • federationObject

      资源。

      • uuidString

        资源的UUID，唯一标识该资源。

        示例： fed-001

      • ssoConfigUuidString

        SSO配置UUID。

        示例： sso-cfg-001

      • platformUuidString

        平台UUID。

        示例： platform-abc123

      • productTypeString

        产品类型。

        示例： zstack

      • ssoClientUuidString

        SSO客户端UUID。

        示例： client-xyz

      • callbackUrlString

        回调地址。

        示例： https://platform.example.com/sso/callback

      • metadataString

        附加元数据。

        示例： {}

      • statusString

        状态信息。

        示例： success

      • errorMessageString

        错误返回消息。

        示例： authentication failed

      • federatedAtString

        联邦时间。

        示例： 2026-01-15T08:00:00Z

      • updatedAtString

        更新时间。

        示例： 2026-01-15T08:00:00Z

      • ssoConfigNameString

        SSO配置名称。

        示例： Corporate SSO

  • totalInteger

    返回结果总数。

    示例： 3

  • limitInteger

    最大返回条目数。

    示例： 20

  • offsetInteger

    查询起始偏移量。

    示例： 20

请求地址

GET/api/v1/sso/federations

/api/v1/sso/federations

操作 ID

ListFederationStatus

永久链接

请求示例

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

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史