Skip to main content
API Explorer|API Explorer
Infrastructure/Federation & SSO
POSTFederationSince 1.0SynchronousAuth Required

FederateSSO

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • idStringRequired

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

Body Fields

  • tenantUuidStringRequired

    Deprecated and ignored. SSO configurations are global.

    Example: deprecated-tenant-uuid

  • platformUuidsListRequired

    Platform uuids

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • platformUuidString

      UUID of the platform that received the federation push.

      Example: platform-abc123

    • productTypeString

      Product type of the platform that received the federation.

      Example: zstack

    • statusString

      Status of the federation operation for this platform.

      Example: success

    • ssoClientUuidString

      Client UUID assigned by the platform after successful federation.

      Example: client-xyz

    • callbackUrlString

      Callback URL registered on the platform for this federation.

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

    • errorString

      Error description if federation to this platform failed.

      Example: connection refused

    • scimUserProvisioningErrorString

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

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

    • scimGroupProvisioningErrorString

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

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

Endpoint

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

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

Operation ID

FederateSSO

Permalink

Request Example

curl -X POST '{host}/api/v1/sso/configurations/{id}/federate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantUuid":"deprecated-tenant-uuid","platformUuids":"item1,item2"}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history