File: //snap/google-cloud-cli/current/lib/surface/iam/workforce_pools/providers/scim_tenants/delete.yaml
# -*- coding: utf-8 -*- #
# Copyright 2025 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Implementation definition for gcloud iam workforce-pools providers scim-tenants delete
- release_tracks: [ALPHA, BETA, GA]
help_text:
brief: Delete an IAM workforce identity pool provider SCIM tenant.
description: |
Delete an existing SCIM tenant associated with a specific workforce identity pool provider.
This operation marks the tenant for deletion, and it may be recoverable using the `undelete` command for a period.
examples: |
To delete a SCIM tenant with ID `my-tenant` under provider `my-okta-provider` in pool `my-pool` located in `global`:
$ {command} my-tenant --location=global --workforce-pool=my-pool --provider=my-okta-provider
request:
collection: iam.locations.workforcePools.providers.scimTenants
api_version: v1
modify_request_hooks:
- googlecloudsdk.command_lib.iam.hooks:ModifyHardDeleteFlagInRequest
arguments:
resource:
help_text: The SCIM tenant to delete.
spec: !REF googlecloudsdk.command_lib.iam.resources:workforce_pool_provider_scim_tenant
is_positional: true
params:
- arg_name: hard-delete
api_field: hardDelete
required: false
help_text: Deletes the SCIM tenant immediately. This operation cannot be undone.