更新ZIAM同步目标

更新一个下游 SCIM 目标。

PUT/api/v1/ziam/sync-targets/{id}

操作 ID

ZiamUpdateSyncTarget

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

id
String必填
资源ID。
示例： cloud-main
owner
String必填
资源。
示例： zstack
name
String必填
资源名称。
示例： zstack-cloud-main
organization
String必填
资源。
示例： zstack
type
String必填
类型。
示例： scim

响应状态

200 OK

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

status
String
状态信息。
示例： ok
data
Object
返回数据。
- id
  String
  资源ID。
  示例： cloud-main
- owner
  String
  资源。
  示例： zstack
- name
  String必填
  资源名称。
  示例： zstack-cloud-main
- organization
  String
  资源。
  示例： zstack
- type
  String
  类型。
  示例： scim
- enabled
  Boolean
  是否启用。
  示例： true
- baseUrl
  String必填
  基础地址。
  示例： https://cloud.example.com/scim/v2
- tokenRef
  String必填
  资源。
  示例： secret/cloud-scim-token
- resources
  List
  资源列表。
  示例： item1,item2
- resourceConfigs
  List
  资源配置。
  示例： (nested array)
  resource
  String必填
  资源名称。
  示例： Organizations
  fieldMappings
  List
  资源。
  示例： (nested array)
  source
  String必填
  来源信息。
  示例： parentId
  target
  String必填
  目标对象。
  示例： parentUuid
  required
  Boolean
  是否必填。
  示例： true
  defaultValue
  String
  资源。
  示例： Department
  roleMappings
  List
  资源。
  示例： (nested array)
  roleKey
  String必填
  ZIAM角色键。
  示例： project-admin
  downstreamRoleId
  String
  下游角色ID。
  示例： cloud-role-admin
  downstreamRoleUuid
  String
  下游角色UUID。
  示例： cloud-role-admin
  targetAccountId
  String
  可选下游账户ID角色映射。
  示例： account-001
  targetAccountUuid
  String
  可选下游账户UUID角色映射。
  示例： account-001

请求示例

curl -X PUT '{host}/api/v1/ziam/sync-targets/{id}' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "cloud-main",
  "owner": "zstack",
  "name": "zstack-cloud-main",
  "organization": "zstack",
  "type": "scim",
  "enabled": "true",
  "baseUrl": "https://cloud.example.com/scim/v2",
  "tokenRef": "secret/cloud-scim-token",
  "resources": [
    "{resources}"
  ],
  "resourceConfigs": [
    {
      "resource": "Organizations",
      "fieldMappings": [
        {
          "source": "parentId",
          "target": "parentUuid",
          "required": "true",
          "defaultValue": "Department"
        }
      ],
      "roleMappings": [
        {
          "roleKey": "project-admin",
          "downstreamRoleId": "cloud-role-admin",
          "downstreamRoleUuid": "cloud-role-admin",
          "targetAccountId": "account-001",
          "targetAccountUuid": "account-001"
        }
      ]
    }
  ]
}'

响应示例

{
  "status": "ok",
  "data": {
    "id": "cloud-main",
    "owner": "zstack",
    "name": "zstack-cloud-main",
    "organization": "zstack",
    "type": "scim",
    "enabled": true,
    "baseUrl": "https://cloud.example.com/scim/v2",
    "tokenRef": "secret/cloud-scim-token"
  }
}

Agent 插件

Agent 管理

资产

指标目录与保留策略

采集任务

基础设施综合

安装器

生命周期

OTA 升级计划

OTA 版本与策略

联邦与 SSO

变更管理

资源删除

生命周期升级

指标采集

监控缓存

监控查询与概览

自动修复

监控综合

Grafana 集成

Grafana 仪表盘

日志

性能剖析

Zaku

告警规则

告警模板

告警通道与集成

告警事件

告警路由与策略

值班

SLO

健康检查

凭证

ZIAM

安全

ZMetis 审计

平台管理

平台联邦

平台自监控

平台健康

平台综合

ZMetis 任务

认证信息

请求参数

请求体字段

响应状态