Method: locations.workforcePools.providers.scimTenants.list

Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If showDeleted is set to true, then deleted SCIM tenants are also listed.

HTTP request

GET https://iam.googleapis.com/v1/{parent=locations/*/workforcePools/*/providers/*}/scimTenants

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforcePool}/providers/{provider}'

Query parameters

Parameters
pageSize

integer

Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.
pageToken

string

Optional. Agentspace only. A page token, received from a previous ListScimTenants call. Provide this to retrieve the subsequent page.
showDeleted

boolean

Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.

Request body

The request body must be empty.

Response body

Agentspace only. Response message for scimTenants.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "workforcePoolProviderScimTenants": [
    {
      object (WorkforcePoolProviderScimTenant)
    }
  ],
  "nextPageToken": string
}
Fields
workforcePoolProviderScimTenants[]

object (WorkforcePoolProviderScimTenant)

Output only. Agentspace only. A list of SCIM tenants.
nextPageToken

string

Optional. Agentspace only. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.