Method: locations.workforcePools.providers.list

Lists all non-deletedWorkforcePoolProviders in aWorkforcePool. IfshowDeleted is set totrue, then deleted providers are also listed.

HTTP request

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

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The pool to list providers for.

Format:locations/{location}/workforcePools/{workforcePoolId}

Query parameters

Parameters
pageSize

integer

The maximum number of providers to return. If unspecified, at most 50 providers are returned. The maximum value is 100; values above 100 are truncated to 100.

pageToken

string

A page token, received from a previousproviders.list call. Provide this to retrieve the subsequent page.

showDeleted

boolean

Whether to return soft-deleted providers.

Request body

The request body must be empty.

Response body

Response message for providers.list.

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

JSON representation
{"workforcePoolProviders":[{object (WorkforcePoolProvider)}],"nextPageToken":string}
Fields
workforcePoolProviders[]

object (WorkforcePoolProvider)

A list of providers.

nextPageToken

string

A token, which can be sent aspageToken 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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-21 UTC.