跳转到主要内容
ZStack
基础设施相关接口/联邦与 SSO

联邦化单点登录

推送SSO配置目标平台联邦。

POST/api/v1/sso/configurations/{id}/federate

操作 ID

FederateSSO

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • id
    String必填

    资源ID。

请求体字段

  • tenantUuid
    String必填

    租户UUID。

    示例： deprecated-tenant-uuid

  • platformUuids
    List必填

    平台UUID。

    示例： item1,item2

  • targets
    List必填

    目标列表。

    示例： (nested array)

    • platformUuid
      String

      平台UUID。

      示例： value

    • scimBaseUrl
      String

      SCIM基础URL。

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

    • scimToken
      String

      SCIM令牌。

      示例： value

    • scimSyncScope
      List

      SCIM资源类型已启用平台。

      示例： item1,item2

    • scimTestPassed
      Boolean

      SCIM测试已通过。

      示例： true

    • resourceConfigs
      List

      资源配置。

      示例： (nested array)

      • resource
        String

        资源名称。

        示例： value

      • fieldMappings
        List

        字段映射。

        示例： (nested array)

        • source
          String

          来源信息。

          示例： value

        • target
          String

          目标对象。

          示例： value

        • required
          Boolean

          是否必填。

          示例： true

        • defaultValue
          String

          默认值。

          示例： value

      • roleMappings
        List

        角色映射。

        示例： (nested array)

        • roleKey
          String

          稳定的角色键ZIAM casdoor。

          示例： value

        • downstreamRoleUuid
          String

          角色UUID预期下游平台。

          示例： value

        • targetAccountUuid
          String

          目标账户UUID。

          示例： value

响应状态

200 OK
200 OK

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

  • items
    List

    条目列表。

    示例： (nested array)

    • platformUuid
      String

      平台UUID。

      示例： platform-abc123

    • productType
      String

      产品类型。

      示例： zstack

    • status
      String

      状态信息。

      示例： success

    • ssoClientUuid
      String

      SSO客户端UUID。

      示例： client-xyz

    • callbackUrl
      String

      回调地址。

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

    • error
      String

      错误码。操作成功时为 null，失败时返回具体错误信息。

      示例： connection refused

    • scimUserProvisioningError
      String

      SCIM用户预配错误。

      示例： sync SCIM users to platform platform-abc123: request timeout

    • scimGroupProvisioningError
      String

      SCIM组预配错误。

      示例： sync SCIM groups to platform platform-abc123: request timeout

变更历史

查看全部变更历史

  • 变更时间

    新增请求体字段 fieldMappings, platformUuid, resource...
    查看 API