Method: getRecaptchaConfig

reCAPTCHA 분석에 필요한 매개변수를 가져옵니다.

HTTP 요청

GET https://identitytoolkit.googleapis.com/v2/recaptchaConfig

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
tenantId

string

테넌트의 ID입니다.

clientType

enum (ClientType)

reCAPTCHA Enterprise는 다양한 클라이언트 유형에 별도의 사이트 키를 사용합니다. 해당 키를 가져오려면 클라이언트 유형을 지정합니다.

version

enum (RecaptchaVersion)

reCAPTCHA 버전입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

reCAPTCHA 구성

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
필드
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

GCIP에서 reCAPTCHA 보호를 지원하는 제공업체의 reCAPTCHA 시행 상태입니다.

recaptchaKey

string

reCAPTCHA Enterprise 키 리소스 이름입니다(예: 'projects/{project}/keys/{key}'). 이 필드는 reCAPTCHA 제공업체 중 하나 이상에서 reCAPTCHA 시행 상태가 AUDIT 또는 ENFORCE인 경우에만 반환됩니다.

useSmsBotScore

boolean

reCAPTCHA 전화 제공업체에 rCE 봇 점수를 사용할지 여부입니다.

useSmsTollFraudProtection

boolean

reCAPTCHA 전화 제공업체에 rCE SMS 전화 결제 사기 방지 위험 점수를 사용할지 여부입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview를 참고하세요.

RecaptchaEnforcementState

reCAPTCHA 보호의 시정 조치 상태입니다.

JSON 표현
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
필드
provider

enum (RecaptchaProvider)

reCAPTCHA 보호 기능이 있는 제공업체입니다.

enforcementState

enum (EnforcementState)

제공업체의 reCAPTCHA 시행 상태입니다.

RecaptchaProvider

reCAPTCHA 보호를 지원하는 GCIP 제공업체입니다.

열거형
RECAPTCHA_PROVIDER_UNSPECIFIED reCAPTCHA 제공업체가 지정되지 않음
EMAIL_PASSWORD_PROVIDER 이메일 비밀번호 제공업체
PHONE_PROVIDER 전화 인증 제공업체

EnforcementState

제공업체별 reCAPTCHA 보호의 시행 상태입니다.

열거형
ENFORCEMENT_STATE_UNSPECIFIED 시정 조치 상태가 설정되지 않았습니다.
OFF 적용되지 않음
AUDIT reCAPTCHA 평가가 생성되었으나 결과가 시행에 사용되지 않습니다.
ENFORCE reCAPTCHA 평가가 생성되고 결과가 적용에 사용됩니다.