Skip to main content
ZStack
Infrastructure/Federation & SSO

FederateSSO

Push an SSO configuration to one or more target platforms for federation.

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

Operation ID

FederateSSO

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

Path Parameters

  • id
    StringRequired

    Unique identifier of the SSO configuration to push to target platforms.

Body Fields

  • tenantUuid
    StringRequired

    Deprecated and ignored. SSO configurations are global.

    Example: deprecated-tenant-uuid

  • platformUuids
    ListRequired

    Platform uuids

    Example: item1,item2

  • targets
    ListRequired

    Per-platform federation targets with optional SCIM configuration.

    Example: (nested array)

    • platformUuid
      String

      UUID of the platform to federate to.

      Example: value

    • scimBaseUrl
      String

      Downstream SCIM endpoint base URL for this platform.

      Example: https://example.com/callback

    • scimToken
      String

      Optional SCIM bearer token. Empty means federation generates and stores a random token.

      Example: value

    • scimSyncScope
      List

      SCIM resource types enabled for this platform.

      Example: item1,item2

    • scimTestPassed
      Boolean

      Whether the frontend/backend has already validated this SCIM endpoint.

      Example: true

    • resourceConfigs
      List

      Resource-specific field and role mappings for this platform.

      Example: (nested array)

      • 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)

        • 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)

        • 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

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • platformUuid
      String

      UUID of the platform that received the federation push.

      Example: platform-abc123

    • productType
      String

      Product type of the platform that received the federation.

      Example: zstack

    • status
      String

      Status of the federation operation for this platform.

      Example: success

    • ssoClientUuid
      String

      Client UUID assigned by the platform after successful federation.

      Example: client-xyz

    • callbackUrl
      String

      Callback URL registered on the platform for this federation.

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

    • error
      String

      Error description if federation to this platform failed.

      Example: connection refused

    • scimUserProvisioningError
      String

      Error description if SCIM user provisioning partially or fully failed after SSO federation.

      Example: sync SCIM users to platform platform-abc123: request timeout

    • scimGroupProvisioningError
      String

      Error description if SCIM group provisioning partially or fully failed after SSO federation.

      Example: sync SCIM groups to platform platform-abc123: request timeout

Change History

View all change history

  • Change Time

    AddedRequest body fields fieldMappings, platformUuid, resource...
    View API