Method: projects.keys.retrieveLegacySecretKey

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
key

string

Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.

Request body

The request body must be empty.

Response body

Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.

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

JSON representation 
{
  "legacySecretKey": string
}
Fields
legacySecretKey

string

The secret key (also known as shared secret) authorizes communication between your application backend and the reCAPTCHA Enterprise server to create an assessment. The secret key needs to be kept safe for security purposes.

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 key resource:

  • recaptchaenterprise.keys.retrievelegacysecretkey

For more information, see the IAM documentation.