Skip to main content

scim_tenants

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

Overview​

Namescim_tenants
TypeResource
Idgoogle.iam.scim_tenants

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringIdentifier. Agentspace only. The resource name of the SCIM Tenant. Format: locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}
baseUristringOutput only. Agentspace 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}/
claimMappingobjectOptional. Agentspace only. Maps BYOID claims to SCIM claims.
descriptionstringOptional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
displayNamestringOptional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
purgeTimestring (google-datetime)Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
serviceAgentstringOutput only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
statestringOutput only. Agentspace only. The state of the tenant.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlocationsId, workforcePoolsId, providersId, scimTenantsIdAgentspace only. Gets an individual WorkforcePoolProviderScimTenant.
listselectlocationsId, workforcePoolsId, providersIdpageSize, pageToken, showDeletedAgentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If show_deleted is set to true, then deleted SCIM tenants are also listed.
createinsertlocationsId, workforcePoolsId, providersIdworkforcePoolProviderScimTenantIdAgentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.
patchupdatelocationsId, workforcePoolsId, providersId, scimTenantsIdupdateMaskAgentspace only. Updates an existing WorkforcePoolProviderScimTenant.
deletedeletelocationsId, workforcePoolsId, providersId, scimTenantsIdhardDeleteAgentspace 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.
undeleteexeclocationsId, workforcePoolsId, providersId, scimTenantsIdAgentspace only. Undeletes a WorkforcePoolProviderScimTenant, that 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.

NameDatatypeDescription
locationsIdstring
providersIdstring
scimTenantsIdstring
workforcePoolsIdstring
hardDeleteboolean
pageSizeinteger (int32)
pageTokenstring
showDeletedboolean
updateMaskstring (google-fieldmask)
workforcePoolProviderScimTenantIdstring

SELECT examples​

Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.

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

INSERT examples​

Agentspace only. 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,
serviceAgent,
state
;

UPDATE examples​

Agentspace only. 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,
serviceAgent,
state;

DELETE examples​

Agentspace 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.

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

Lifecycle Methods​

Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that 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
;