delete method

Future<WorkforcePoolProviderScimTenant> delete(
  1. String name, {
  2. bool? hardDelete,
  3. String? $fields,
})

Gemini Enterprise only.

Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

Request parameters:

name - Required. Gemini Enterprise only. The name of the SCIM tenant to delete. Format: locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant} Value must have pattern ^locations/\[^/\]+/workforcePools/\[^/\]+/providers/\[^/\]+/scimTenants/\[^/\]+$.

hardDelete - Optional. Deletes the SCIM tenant immediately. This operation cannot be undone.

$fields - Selector specifying which fields to include in a partial response.

Completes with a WorkforcePoolProviderScimTenant.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<WorkforcePoolProviderScimTenant> delete(
  core.String name, {
  core.bool? hardDelete,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'hardDelete': ?hardDelete == null ? null : ['${hardDelete}'],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'DELETE',
    queryParams: queryParams_,
  );
  return WorkforcePoolProviderScimTenant.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}