Skip to main content
ZStack
Infrastructure/Federation & SSO

PreviewDeleteSSOConfig

Preview the deletion impact for SSOConfig without mutating state. Returns blockers, cascade resources, orphan resources, finalizers, and available policies.

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

Operation ID

PreviewDeleteSSOConfig

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 preview for deletion.

Body Fields

  • tenantUuid
    StringRequired

    Deprecated and ignored. SSO configurations are global.

    Example: deprecated-tenant-uuid

  • options
    ObjectRequired

    Options for this resource

    • propagationPolicy
      String

      PropagationPolicy overrides the resource's default policy when non-empty. Accepted values: Restrict, Foreground, Background, Orphan, SoftDelete.

      Example: value

    • force
      Boolean

      Force skips the Finalizer phase and advances directly to PhysicalDelete. Requires operator-level permission; returns PermissionDenied until the audit-integration rollout lands.

      Example: true

    • gracePeriodSeconds
      Integer

      GracePeriodSeconds defines the post-request delay before the engine begins the Checking phase. Default 0 (immediate).

      Example: 10

    • revokeRemoteCredentials
      Boolean

      RevokeRemoteCredentials is a resource-scoped hint for resources that carry out-of-band credentials (e.g. Platform access keys). When true, the corresponding revoke finalizer is activated for this request. Ignored by resources that do not register such a finalizer.

      Example: true

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • blockers
    List

    Resources that are blocking the deletion from proceeding

    Example: (nested array)

    • resourceType
      String

      Type of the blocking resource

      Example: VmNic

    • resourceUuid
      String

      UUID of the blocking resource

      Example: b2c3d4e5-f6a7-8901-bcde-f12345678901

    • resourceName
      String

      Human-readable name of the blocking resource

      Example: nic-001

    • relation
      String

      Relationship between the blocker and the target resource

      Example: AttachedTo

    • suggestion
      String

      Recommended action to resolve the blocker

      Example: Detach the NIC before deleting the VM

    • hard
      Boolean

      Whether this blocker prevents deletion entirely (hard) or is a warning

      Example: true

  • cascadeResources
    List

    Resources that will be deleted in cascade along with the target

    Example: (nested array)

    • resourceType
      String

      Type of the related resource

      Example: Volume

    • resourceUuid
      String

      UUID of the related resource

      Example: c3d4e5f6-a7b8-9012-cdef-123456789012

    • resourceName
      String

      Human-readable name of the related resource

      Example: vol-data-01

  • orphanResources
    List

    Resources that will become orphaned after the deletion

    Example: (nested array)

    • resourceType
      String

      Type of the related resource

      Example: Volume

    • resourceUuid
      String

      UUID of the related resource

      Example: c3d4e5f6-a7b8-9012-cdef-123456789012

    • resourceName
      String

      Human-readable name of the related resource

      Example: vol-data-01

  • finalizers
    List

    Finalizer handlers that must complete before deletion is finished

    Example: (nested array)

    • name
      String

      Unique name identifying this finalizer handler

      Example: cleanup-network

    • description
      String

      Human-readable description of what this finalizer does

      Example: Releases network interfaces associated with the resource

    • status
      String

      Current execution status of the finalizer

      Example: Succeeded

    • error
      String

      Error message if the finalizer failed

      Example: timeout waiting for network release

  • availablePolicies
    List

    Deletion propagation policies available for this resource type

    Example: item1,item2

  • softDeleteRecoverable
    Boolean

    Whether this resource supports recovery after soft deletion

    Example: true