Method: locations.workforcePools.providers.keys.list

Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider. If showDeleted is set to true, then deleted keys are also listed.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The provider resource to list encryption keys for.

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

Query parameters

Parameters
pageSize

integer

The maximum number of keys to return. If unspecified, all keys are returned. The maximum value is 10; values above 10 are truncated to 10.
pageToken

string

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

boolean

Whether to return soft-deleted keys.

Request body

The request body must be empty.

Response body

Response message for keys.list.

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

JSON representation 
{
  "workforcePoolProviderKeys": [
    {
      object (WorkforcePoolProviderKey)
    }
  ],
  "nextPageToken": string
}
Fields
workforcePoolProviderKeys[]

object (WorkforcePoolProviderKey)

A list of WorkforcePoolProviderKeys.
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.