Method: projects.keys.list

Returns the list of all keys that belong to a project.

HTTP request

GET https://recaptchaenterprise.googleapis.com/v1/{parent=projects/*}/keys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project that contains the keys that is listed, in the format projects/{project} .

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.

pageToken

string

Optional. The nextPageToken value returned from a previous. ListKeysRequest, if any.

Request body

The request body must be empty.

Response body

Response to request to list keys in a project.

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

JSON representation
 { 
 "keys" 
 : 
 [ 
 { 
 object (  Key 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 } 
Fields
keys[]

object ( Key )

Key details.

nextPageToken

string

Token to retrieve the next page of results. It is set to empty if no keys remain in results.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

  • recaptchaenterprise.keys.list

For more information, see the IAM documentation .

Design a Mobile Site
View Site in Mobile | Classic
Share by: