Skip to main content
ZStack
Identity & Access/ZIAM

ZiamUpsertSyncTarget

Creates or updates a downstream SCIM target. Secrets are referenced through tokenRef and are not stored in clear text inside the target payload.

POST/api/v1/ziam/sync-targets

Operation ID

ZiamUpsertSyncTarget

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • id
    StringRequired

    Stable sync target identifier.

    Example: cloud-main

  • owner
    StringRequired

    Owner for this resource

    Example: zstack

  • name
    StringRequired

    Human-readable sync target name.

    Example: zstack-cloud-main

  • organization
    StringRequired

    Organization for this resource

    Example: zstack

  • type
    StringRequired

    Sync target protocol type.

    Example: scim

Responses

201 Created
201 Created

On success, this API returns the following response structure.

  • status
    String

    Status for this resource

    Example: ok

  • data
    Object

    Response payload data

    • id
      String

      Stable sync target identifier.

      Example: cloud-main

    • owner
      String

      Owner for this resource

      Example: zstack

    • name
      StringRequired

      Human-readable sync target name.

      Example: zstack-cloud-main

    • organization
      String

      Organization for this resource

      Example: zstack

    • type
      String

      Sync target protocol type.

      Example: scim

    • enabled
      Boolean

      Enabled for this resource

      Example: true

    • baseUrl
      StringRequired

      Base url for this resource

      Example: https://cloud.example.com/scim/v2

    • tokenRef
      StringRequired

      Token ref for this resource

      Example: secret/cloud-scim-token

    • resources
      List

      Associated resource list

      Example: item1,item2

    • resourceConfigs
      List

      Optional per-resource sync config. If resources is omitted and resourceConfigs is provided, ZIAM derives resources from this list.

      Example: (nested array)

      • resource
        StringRequired

        Resource for this resource

        Example: Organizations

      • fieldMappings
        List

        Field mappings for this resource

        Example: (nested array)

        • source
          StringRequired

          ZIAM resource field name.

          Example: parentId

        • target
          StringRequired

          Downstream field name.

          Example: parentUuid

        • required
          Boolean

          Required for this resource

          Example: true

        • defaultValue
          String

          Default value for this resource

          Example: Department

      • roleMappings
        List

        Role mappings for this resource

        Example: (nested array)

        • roleKey
          StringRequired

          ZIAM role key.

          Example: project-admin

        • downstreamRoleId
          String

          Downstream role id.

          Example: cloud-role-admin

        • downstreamRoleUuid
          String

          Downstream role uuid.

          Example: cloud-role-admin

        • targetAccountId
          String

          Optional downstream account id for role mapping.

          Example: account-001

        • targetAccountUuid
          String

          Optional downstream account uuid for role mapping.

          Example: account-001