UpdateSSOPlatformSCIM

On success, this API returns the following response structure.

• uuid

  String

  Unique identifier of this federation record.

  Example: fed-001

• ssoConfigUuid

  String

  UUID of the SSO configuration that was federated.

  Example: sso-cfg-001

• platformUuid

  String

  UUID of the target platform to which the SSO config was pushed.

  Example: platform-abc123

• productType

  String

  Product type of the target platform receiving the federation.

  Example: zstack

• ssoClientUuid

  String

  Client UUID assigned by the target platform after successful federation.

  Example: client-xyz

• callbackUrl

  String

  Callback URL registered on the target platform for this federation.

  Example: https://platform.example.com/sso/callback

• metadata

  String

  Additional metadata associated with this federation record.

  Example: {}

• status

  String

  Current status of the federation operation.

  Example: success

• errorMessage

  String

  Error message if the federation operation failed.

  Example: authentication failed

• federatedAt

  String

  Federated at

  Example: 2026-01-15T08:00:00Z

• updatedAt

  String

  Updated at

  Example: 2026-01-15T08:00:00Z

• ssoConfigName

  String

  Display name of the SSO configuration that was federated to this platform.

  Example: Corporate SSO

• configStatus

  String

  Configuration dispatch status for this platform association.

  Example: value

• readyStatus

  String

  Whether the downstream SCIM endpoint is ready for synchronization.

  Example: value

• syncStatus

  String

  Current SCIM synchronization status for this platform association.

  Example: value

• lastSyncAt

  String

  Last successful SCIM sync time for this platform association.

  Example: 2026-01-15T08:00:00Z

• scimBaseUrl

  String

  Downstream SCIM endpoint base URL configured for this association.

  Example: https://example.com/callback

• scimTokenConfigured

  Boolean

  Whether this federation has a stored SCIM bearer token.

  Example: true

• scimSyncScope

  List

  SCIM resource types enabled for this association.

  Example: item1,item2

• scimResourceConfigs

  List

  Resource-specific field and role mappings for this association.

  Example: (nested array)

  Show child properties
  • resource

    String

    SCIM resource type, e.g. Users, Groups, Roles, or RoleBindings.

    Example: value

  • fieldMappings

    List

    Field mappings applied before dispatching events to this target.

    Example: (nested array)

    Show child properties
    • source

      String

      Source field name in the ZIAM SCIM event payload.

      Example: value

    • target

      String

      Target field name expected by the downstream platform.

      Example: value

    • required

      Boolean

      Whether this mapped field must be present after defaulting.

      Example: true

    • defaultValue

      String

      Default value used when the source field is empty.

      Example: value

  • roleMappings

    List

    Role mappings applied to RoleBindings events before dispatching.

    Example: (nested array)

    Show child properties
    • roleKey

      String

      Stable role key from ZIAM/Casdoor.

      Example: value

    • downstreamRoleUuid

      String

      Role UUID expected by the downstream platform.

      Example: value

    • targetAccountUuid

      String

      Optional downstream account UUID used for role binding creation.

      Example: value

• scimLastTestAt

  String

  Last time the SCIM endpoint was tested.

  Example: 2026-01-15T08:00:00Z

• scimLastTestResult

  String

  Result of the most recent SCIM endpoint test.

  Example: value

• scimLastTestError

  String

  Error from the most recent SCIM endpoint test.

  Example: value