2025-07-24
▼ ▲ iam.locations.workforcePools.providers.scimTenants.list
Path : v1/{+parent}/scimTenants
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants
HTTP Method : GET
Parameters :
parent
Description : Required. The parent to list scim tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of scim tenants to return. If unspecified, at most 1 scim tenant will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
showDeleted
Description : Optional. Whether to return soft-deleted scim tenants.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim tenants are also listed.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.get
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the scim tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an individual WorkforcePoolProviderScimTenant.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.create
Path : v1/{+parent}/scimTenants
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants
HTTP Method : POST
Parameters :
parent
Description : Required. The parent to create scim tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$
Location : path
Required : Yes
Type : string
workforcePoolProviderScimTenantId
Description : Required. The ID to use for the scim tenant, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.patch
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing WorkforcePoolProviderScimTenant.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.delete
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : 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.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.undelete
Path : v1/{+name}:undelete
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete
HTTP Method : POST
Parameters :
name
Description : Required. The name of the scim tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.list
Path : v1/{+parent}/tokens
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens
HTTP Method : GET
Parameters :
parent
Description : Required. The parent to list scim tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of scim tokens to return. If unspecified, at most 2 scim tokens will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
showDeleted
Description : Optional. Whether to return soft-deleted scim tokens.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.get
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the scim token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an individual WorkforcePoolProviderScimToken.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.create
Path : v1/{+parent}/tokens
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens
HTTP Method : POST
Parameters :
parent
Description : Required. The parent tenant to create scim token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$
Location : path
Required : Yes
Type : string
workforcePoolProviderScimTokenId
Description : Required. The ID to use for the scim token, which becomes the final component of the resource name. This value should be 4-32 characters and follow this pattern: "([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))"
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.patch
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing WorkforcePoolProviderScimToken.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.delete
Path : v1/{+name}
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the scim token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.
▼ ▲ iam.locations.workforcePools.providers.scimTenants.tokens.undelete
Path : v1/{+name}:undelete
Flat Path : v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}:undelete
HTTP Method : POST
Parameters :
name
Description : Required. The name of the scim token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`
Pattern : ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.