Method: locations.workforcePools.providers.list

Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If showDeleted is set to true, then deleted providers are also listed.

HTTP request

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

The URL uses gRPC 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 previous providers.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 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.