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

更新单点登录平台SCIM

更新关联平台的 SCIM URL、令牌引用、同步范围及映射。

PUT/api/v1/sso/configurations/{id}/platforms/{platformUuid}/scim

操作 ID

UpdateSSOPlatformSCIM

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • id
    String必填

    资源ID。

  • platformUuid
    String必填

    平台UUID。

请求体字段

  • scimBaseUrl
    String必填

    下游SCIM基础URL。

    示例： https://cloud.example.com/zstack/scim/v2

  • scimToken
    String必填

    SCIM令牌。

    示例： scim-token-plain-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 成功时返回以下响应结构。

  • uuid
    String

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

    示例： fed-001

  • ssoConfigUuid
    String

    SSO配置UUID。

    示例： sso-cfg-001

  • platformUuid
    String

    平台UUID。

    示例： platform-abc123

  • productType
    String

    产品类型。

    示例： zstack

  • ssoClientUuid
    String

    SSO客户端UUID。

    示例： client-xyz

  • callbackUrl
    String

    回调地址。

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

  • metadata
    String

    附加元数据。

    示例： {}

  • status
    String

    状态信息。

    示例： success

  • errorMessage
    String

    错误返回消息。

    示例： authentication failed

  • federatedAt
    String

    联邦时间。

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

  • updatedAt
    String

    更新时间。

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

  • ssoConfigName
    String

    SSO配置名称。

    示例： Corporate SSO

  • configStatus
    String

    配置下发状态平台关联。

    示例： value

  • readyStatus
    String

    就绪状态。

    示例： value

  • syncStatus
    String

    同步状态。

    示例： value

  • lastSyncAt
    String

    最近一次同步时间。

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

  • scimBaseUrl
    String

    SCIM基础地址。

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

  • scimTokenConfigured
    Boolean

    SCIM令牌已配置。

    示例： true

  • scimSyncScope
    List

    SCIM资源类型已启用关联。

    示例： item1,item2

  • scimResourceConfigs
    List

    SCIM资源配置。

    示例： (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

  • scimLastTestAt
    String

    SCIM最近一次测试时间。

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

  • scimLastTestResult
    String

    SCIM最近一次测试结果。

    示例： value

  • scimLastTestError
    String

    SCIM最近一次测试错误。

    示例： value