Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class PrivatePasswordLeakVerification.
Private password leak verification info.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ lookup_hash_prefix
string
Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It is used to look up password leaks associated with that hash prefix.
↳ encrypted_user_credentials_hash
string
Optional. Encrypted Scrypt hash of the canonicalized username+password. It is re-encrypted by the server and returned through reencrypted_user_credentials_hash.
↳ encrypted_leak_match_prefixes
array
Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of reencrypted_user_credentials_hash
↳ reencrypted_user_credentials_hash
string
Output only. Corresponds to the re-encryption of the encrypted_user_credentials_hash field. It is used to match potential password leaks within encrypted_leak_match_prefixes.
getLookupHashPrefix
Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
username. It is used to look up password leaks associated with that hash
prefix.
Returns
Type
Description
string
setLookupHashPrefix
Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
username. It is used to look up password leaks associated with that hash
prefix.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEncryptedUserCredentialsHash
Optional. Encrypted Scrypt hash of the canonicalized username+password. It
is re-encrypted by the server and returned through
reencrypted_user_credentials_hash.
Returns
Type
Description
string
setEncryptedUserCredentialsHash
Optional. Encrypted Scrypt hash of the canonicalized username+password. It
is re-encrypted by the server and returned through
reencrypted_user_credentials_hash.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEncryptedLeakMatchPrefixes
Output only. List of prefixes of the encrypted potential password leaks
that matched the given parameters. They must be compared with the
client-side decryption prefix of reencrypted_user_credentials_hash
Output only. List of prefixes of the encrypted potential password leaks
that matched the given parameters. They must be compared with the
client-side decryption prefix of reencrypted_user_credentials_hash
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getReencryptedUserCredentialsHash
Output only. Corresponds to the re-encryption of the
encrypted_user_credentials_hash field. It is used to match potential
password leaks within encrypted_leak_match_prefixes.
Returns
Type
Description
string
setReencryptedUserCredentialsHash
Output only. Corresponds to the re-encryption of the
encrypted_user_credentials_hash field. It is used to match potential
password leaks within encrypted_leak_match_prefixes.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Recaptcha Enterprise V1 Client - Class PrivatePasswordLeakVerification (2.1.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.3 (latest)](/php/docs/reference/cloud-recaptcha-enterprise/latest/V1.PrivatePasswordLeakVerification)\n- [2.1.2](/php/docs/reference/cloud-recaptcha-enterprise/2.1.2/V1.PrivatePasswordLeakVerification)\n- [2.0.1](/php/docs/reference/cloud-recaptcha-enterprise/2.0.1/V1.PrivatePasswordLeakVerification)\n- [1.17.2](/php/docs/reference/cloud-recaptcha-enterprise/1.17.2/V1.PrivatePasswordLeakVerification)\n- [1.16.1](/php/docs/reference/cloud-recaptcha-enterprise/1.16.1/V1.PrivatePasswordLeakVerification)\n- [1.15.0](/php/docs/reference/cloud-recaptcha-enterprise/1.15.0/V1.PrivatePasswordLeakVerification)\n- [1.14.0](/php/docs/reference/cloud-recaptcha-enterprise/1.14.0/V1.PrivatePasswordLeakVerification)\n- [1.13.0](/php/docs/reference/cloud-recaptcha-enterprise/1.13.0/V1.PrivatePasswordLeakVerification)\n- [1.12.2](/php/docs/reference/cloud-recaptcha-enterprise/1.12.2/V1.PrivatePasswordLeakVerification)\n- [1.8.0](/php/docs/reference/cloud-recaptcha-enterprise/1.8.0/V1.PrivatePasswordLeakVerification)\n- [1.7.0](/php/docs/reference/cloud-recaptcha-enterprise/1.7.0/V1.PrivatePasswordLeakVerification)\n- [1.6.0](/php/docs/reference/cloud-recaptcha-enterprise/1.6.0/V1.PrivatePasswordLeakVerification)\n- [1.5.2](/php/docs/reference/cloud-recaptcha-enterprise/1.5.2/V1.PrivatePasswordLeakVerification)\n- [1.4.2](/php/docs/reference/cloud-recaptcha-enterprise/1.4.2/V1.PrivatePasswordLeakVerification)\n- [1.3.2](/php/docs/reference/cloud-recaptcha-enterprise/1.3.2/V1.PrivatePasswordLeakVerification)\n- [1.2.6](/php/docs/reference/cloud-recaptcha-enterprise/1.2.6/V1.PrivatePasswordLeakVerification) \nReference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class PrivatePasswordLeakVerification.\n\nPrivate password leak verification info.\n\nGenerated from protobuf message `google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ RecaptchaEnterprise \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getLookupHashPrefix\n\nRequired. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized\nusername. It is used to look up password leaks associated with that hash\nprefix.\n\n### setLookupHashPrefix\n\nRequired. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized\nusername. It is used to look up password leaks associated with that hash\nprefix.\n\n### getEncryptedUserCredentialsHash\n\nOptional. Encrypted Scrypt hash of the canonicalized username+password. It\nis re-encrypted by the server and returned through\n`reencrypted_user_credentials_hash`.\n\n### setEncryptedUserCredentialsHash\n\nOptional. Encrypted Scrypt hash of the canonicalized username+password. It\nis re-encrypted by the server and returned through\n`reencrypted_user_credentials_hash`.\n\n### getEncryptedLeakMatchPrefixes\n\nOutput only. List of prefixes of the encrypted potential password leaks\nthat matched the given parameters. They must be compared with the\nclient-side decryption prefix of `reencrypted_user_credentials_hash`\n\n### setEncryptedLeakMatchPrefixes\n\nOutput only. List of prefixes of the encrypted potential password leaks\nthat matched the given parameters. They must be compared with the\nclient-side decryption prefix of `reencrypted_user_credentials_hash`\n\n### getReencryptedUserCredentialsHash\n\nOutput only. Corresponds to the re-encryption of the\n`encrypted_user_credentials_hash` field. It is used to match potential\npassword leaks within `encrypted_leak_match_prefixes`.\n\n### setReencryptedUserCredentialsHash\n\nOutput only. Corresponds to the re-encryption of the\n`encrypted_user_credentials_hash` field. It is used to match potential\npassword leaks within `encrypted_leak_match_prefixes`."]]