scim_tenants

Creates, updates, deletes, gets or lists a scim_tenants resource.

Overview

Name	scim_tenants
Type	Resource
Id	google.iam.scim_tenants

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the SCIM Tenant. Format: locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}
baseUri	string	Output only. Represents the base URI as defined in RFC 7644, Section 1.3. Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
claimMapping	object	Optional. Maps BYOID claims to SCIM claims.
description	string	Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
displayName	string	Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
purgeTime	string (google-datetime)	Output only. The timestamp when the scim tenant is going to be purged.
state	string	Output only. The state of the tenant.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the SCIM Tenant. Format: locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}
baseUri	string	Output only. Represents the base URI as defined in RFC 7644, Section 1.3. Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
claimMapping	object	Optional. Maps BYOID claims to SCIM claims.
description	string	Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
displayName	string	Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
purgeTime	string (google-datetime)	Output only. The timestamp when the scim tenant is going to be purged.
state	string	Output only. The state of the tenant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	locationsId, workforcePoolsId, providersId, scimTenantsId		Gets an individual WorkforcePoolProviderScimTenant.
list	select	locationsId, workforcePoolsId, providersId	pageSize, pageToken, showDeleted	Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If show_deleted is set to true, then deleted scim tenants are also listed.
create	insert	locationsId, workforcePoolsId, providersId	workforcePoolProviderScimTenantId	Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.
patch	update	locationsId, workforcePoolsId, providersId, scimTenantsId	updateMask	Updates an existing WorkforcePoolProviderScimTenant.
delete	delete	locationsId, workforcePoolsId, providersId, scimTenantsId		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.
undelete	exec	locationsId, workforcePoolsId, providersId, scimTenantsId		Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
providersId	string
scimTenantsId	string
workforcePoolsId	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
updateMask	string (google-fieldmask)
workforcePoolProviderScimTenantId	string

SELECT examples

get

Gets an individual WorkforcePoolProviderScimTenant.

SELECT
name,
baseUri,
claimMapping,
description,
displayName,
purgeTime,
state
FROM google.iam.scim_tenants
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND scimTenantsId = '{{ scimTenantsId }}' -- required;

list

Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If show_deleted is set to true, then deleted scim tenants are also listed.

SELECT
name,
baseUri,
claimMapping,
description,
displayName,
purgeTime,
state
FROM google.iam.scim_tenants
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.

INSERT INTO google.iam.scim_tenants (
data__name,
data__description,
data__displayName,
data__claimMapping,
locationsId,
workforcePoolsId,
providersId,
workforcePoolProviderScimTenantId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ displayName }}',
'{{ claimMapping }}',
'{{ locationsId }}',
'{{ workforcePoolsId }}',
'{{ providersId }}',
'{{ workforcePoolProviderScimTenantId }}'
RETURNING
name,
baseUri,
claimMapping,
description,
displayName,
purgeTime,
state
;

Manifest

# Description fields are for documentation purposes
- name: scim_tenants
  props:
    - name: locationsId
      value: string
      description: Required parameter for the scim_tenants resource.
    - name: workforcePoolsId
      value: string
      description: Required parameter for the scim_tenants resource.
    - name: providersId
      value: string
      description: Required parameter for the scim_tenants resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
        
    - name: description
      value: string
      description: >
        Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
        
    - name: displayName
      value: string
      description: >
        Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
        
    - name: claimMapping
      value: object
      description: >
        Optional. Maps BYOID claims to SCIM claims.
        
    - name: workforcePoolProviderScimTenantId
      value: string

UPDATE examples

patch

Updates an existing WorkforcePoolProviderScimTenant.

UPDATE google.iam.scim_tenants
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__claimMapping = '{{ claimMapping }}'
WHERE 
locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND scimTenantsId = '{{ scimTenantsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
baseUri,
claimMapping,
description,
displayName,
purgeTime,
state;

DELETE examples

delete

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.

DELETE FROM google.iam.scim_tenants
WHERE locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND scimTenantsId = '{{ scimTenantsId }}' --required;

Lifecycle Methods

undelete

Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.

EXEC google.iam.scim_tenants.undelete 
@locationsId='{{ locationsId }}' --required, 
@workforcePoolsId='{{ workforcePoolsId }}' --required, 
@providersId='{{ providersId }}' --required, 
@scimTenantsId='{{ scimTenantsId }}' --required;