Package google.cloud.identitytoolkit.v2

색인

AccountManagementService

Identity Toolkit의 계정 관리

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

사용자의 두 번째 단계 등록을 완료합니다.

승인 범위

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

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

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

StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

MFA 등록 절차의 첫 번째 단계입니다. SMS의 경우 사용자에게 SMS 인증 코드가 전송됩니다.

승인 범위

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

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

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

WithdrawMfa

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

계정에 등록된 두 번째 단계 중 하나를 취소합니다.

승인 범위

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

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

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

AuthenticationService

Identity Toolkit 인증

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

MFA 챌린지를 확인하고 로그인을 실행합니다.

승인 범위

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

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

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

GetPasswordPolicy

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

프로젝트 또는 테넌트에 설정된 비밀번호 정책 구성을 가져옵니다.

승인 범위

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

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

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

GetRecaptchaConfig

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

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

승인 범위

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

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

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

RevokeToken

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

ID 공급업체 (IdP)에서 사용자의 토큰을 취소합니다. 이는 IdP 사용자 인증 정보와 취소할 토큰 유형을 수동으로 제공하여 실행됩니다.

Google Cloud 프로젝트를 식별하려면 요청에 API 키가 필요합니다.

승인 범위

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

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

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

StartMfaSignIn

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

MFA 챌린지 전송

승인 범위

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

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

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

AutoRetrievalInfo

SMS를 자동으로 검색하는 데 필요한 정보입니다.

필드
app_signature_hash

string

Google Play 서비스의 SMS Retriever API에 대한 Android 앱의 서명 해시입니다.

ClientType

클라이언트의 플랫폼 유형입니다(웹, Android 또는 iOS).

열거형
CLIENT_TYPE_UNSPECIFIED 클라이언트 유형이 지정되지 않았습니다.
CLIENT_TYPE_WEB 클라이언트 유형은 웹입니다.
CLIENT_TYPE_ANDROID 클라이언트 유형은 Android입니다.
CLIENT_TYPE_IOS 클라이언트 유형은 ios입니다.

FinalizeMfaEnrollmentRequest

사용자의 두 번째 단계 등록을 완료합니다.

필드
id_token

string

필수 입력란입니다. ID 토큰

display_name

string

사용자가 동일한 유형 또는 다른 유형의 2단계 인증을 구분하기 위해 입력하는 표시 이름입니다.

tenant_id

string

MFA를 등록하는 사용자가 속한 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자는 기본 Identity Platform 프로젝트에 속합니다.

통합 필드 verification_info. 확인할 MFA 등록 정보 verification_info은 다음 중 하나여야 합니다.
phone_verification_info

FinalizeMfaPhoneRequestInfo

전화 인증을 위한 SMS 전송을 승인하는 인증 정보입니다.

totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

TOTP 인증 정보입니다.

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment 응답

필드
id_token

string

MFA 등록을 반영하도록 ID 토큰이 업데이트되었습니다.

refresh_token

string

MFA 등록을 반영하도록 갱신 토큰이 업데이트되었습니다.

통합 필드 auxiliary_auth_info. MFA로 등록 정보가 확인되었습니다. auxiliary_auth_info은 다음 중 하나여야 합니다.
phone_auth_info

FinalizeMfaPhoneResponseInfo

전화 인증과 관련된 보조 인증 정보입니다.

totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

TOTP 인증에 관한 보조 인증 정보입니다.

FinalizeMfaPhoneRequestInfo

FinalizeMfa 요청의 전화 인증 정보입니다.

필드
session_info

string

등록 세션을 나타내는 불투명 문자열입니다.

code

string

사용자가 입력한 인증 코드입니다.

android_verification_proof

string

Android 전용입니다. GmsCore를 통한 '즉시' 전화번호 인증에 사용합니다.

phone_number

string

Android 인증 증빙 자료가 제공되는 경우 필수입니다.

FinalizeMfaPhoneResponseInfo

FinalizeMfa 응답의 전화 인증 정보입니다.

필드
android_verification_proof

string

Android 전용입니다. Android 기기에 연결된 유효한 코드의 장기 교체입니다.

android_verification_proof_expire_time

Timestamp

Android 전용입니다. 인증 증빙 자료의 만료 시간(초)입니다.

phone_number

string

Android 인증 증빙 자료

FinalizeMfaSignInRequest

MFA 챌린지를 확인하여 로그인을 완료합니다.

필드
mfa_pending_credential

string

필수 입력란입니다. 첫 번째 단계 로그인에서 대기 중인 사용자 인증 정보

tenant_id

string

사용자가 로그인하는 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자가 기본 Identity Platform 프로젝트에 로그인합니다.

mfa_enrollment_id

string

사용자의 현재 MFA 등록 목록에 있는 MFA 등록 ID입니다.

통합 필드 verification_info. MFA 챌린지 완료 증빙 자료 verification_info은 다음 중 하나여야 합니다.
phone_verification_info

FinalizeMfaPhoneRequestInfo

SMS 기반 MFA 챌린지 완료 증빙 자료

totp_verification_info

MfaTotpSignInRequestInfo

TOTP 기반 MFA 챌린지 완료 증빙 자료

FinalizeMfaSignInResponse

FinalizeMfaSignIn 응답

필드
id_token

string

인증된 사용자의 ID 토큰입니다.

refresh_token

string

인증된 사용자의 갱신 토큰입니다.

통합 필드 auxiliary_auth_info. MFA 인증 로그인 정보 auxiliary_auth_info은 다음 중 하나여야 합니다.
phone_auth_info

FinalizeMfaPhoneResponseInfo

Android 인증 증거를 포함한 추가 휴대전화 인증 정보

FinalizeMfaTotpEnrollmentRequestInfo

FinalizeMfa의 TOTP 인증과 관련된 MFA 요청 정보입니다.

필드
session_info

string

등록 세션을 나타내는 불투명 문자열입니다.

verification_code

string

사용자가 입력한 인증 코드입니다.

FinalizeMfaTotpEnrollmentResponseInfo

이 유형에는 필드가 없습니다.

FinalizeMfa의 TOTP 인증과 관련된 MFA 응답 정보입니다.

GetPasswordPolicyRequest

GetPasswordPolicy 요청입니다.

필드
tenant_id

string

테넌트의 ID입니다.

GetRecaptchaConfigRequest

GetRecaptchaConfig 요청입니다.

필드
tenant_id

string

테넌트의 ID입니다.

client_type

ClientType

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

version

RecaptchaVersion

reCAPTCHA 버전입니다.

MfaTotpSignInRequestInfo

FinalizeMfaSignInRequest의 TOTP 인증 정보입니다.

필드
verification_code

string

사용자가 입력한 인증 코드입니다.

PasswordPolicy

비밀번호 정책 구성

필드
custom_strength_options

CustomStrengthOptions

비밀번호 정책에서 적용하는 맞춤 안전성 옵션입니다.

schema_version

int32

출력 전용입니다. 비밀번호 정책의 스키마 버전 번호입니다.

allowed_non_alphanumeric_characters[]

string

출력 전용입니다. non_alphanumeric 요구사항을 충족하는 허용된 문자입니다.

enforcement_state

EnforcementState

출력 전용입니다. 비밀번호 정책에 사용할 시행 모드입니다.

force_upgrade_on_signin

bool

사용자는 비밀번호 정책을 준수하는 비밀번호를 사용하여 로그인해야 합니다.

CustomStrengthOptions

사용자 비밀번호에 적용할 맞춤 안전성 옵션입니다.

필드
min_password_length

int32

비밀번호 최소 길이 범위는 6~30입니다.

max_password_length

int32

비밀번호 최대 길이입니다. 기본 최대 길이 없음

contains_lowercase_character

bool

비밀번호에 소문자가 포함되어야 합니다.

contains_uppercase_character

bool

비밀번호에 대문자가 포함되어야 합니다.

contains_numeric_character

bool

비밀번호에 숫자가 포함되어야 합니다.

contains_non_alphanumeric_character

bool

비밀번호에 영숫자 문자가 아닌 문자가 포함되어야 합니다.

EnforcementState

비밀번호 정책의 시행 상태

열거형
ENFORCEMENT_STATE_UNSPECIFIED 시정 조치 상태가 설정되지 않았습니다.
OFF 프로젝트에 비밀번호 정책이 사용되지 않습니다.
ENFORCE 비밀번호 정책을 준수하지 않는 비밀번호는 오류가 발생하여 거부됩니다.

RecaptchaConfig

reCAPTCHA 구성

필드
recaptcha_enforcement_state[]

RecaptchaEnforcementState

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

recaptcha_key

string

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

use_sms_bot_score

bool

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

use_sms_toll_fraud_protection

bool

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

RecaptchaEnforcementState

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

필드
provider

RecaptchaProvider

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

enforcement_state

EnforcementState

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

EnforcementState

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

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

RecaptchaProvider

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

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

RecaptchaVersion

reCAPTCHA 버전입니다.

열거형
RECAPTCHA_VERSION_UNSPECIFIED reCAPTCHA 버전이 지정되지 않았습니다.
RECAPTCHA_ENTERPRISE reCAPTCHA Enterprise

RevokeTokenRequest

RevokeToken 요청 메시지입니다.

필드
provider_id

string

필수 입력란입니다. 토큰의 ID 공급자입니다. 현재 Apple IDP만 지원합니다. 형식은 'apple.com'이어야 합니다.

token_type

TokenType

필수 입력란입니다. 취소할 토큰의 유형입니다.

token

string

필수 입력란입니다. 취소할 토큰입니다. authorization_code가 전달되면 API는 먼저 코드를 액세스 토큰으로 교환한 다음 교환된 토큰을 취소합니다.

id_token

string

필수 입력란입니다. 계정을 연결할 유효한 Identity Platform ID 토큰 계정에서 토큰 취소 요청이 성공적으로 처리되었고 취소 후 토큰이 생성되지 않은 경우 중복 요청은 무시되고 즉시 반환됩니다.

tenant_id

string

사용자가 로그인하는 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자가 기본 Identity Platform 프로젝트에 로그인합니다.

redirect_uri

string

클라이언트가 IDP에 보낸 초기 승인 요청에 제공된 리디렉션 URI입니다. URI는 HTTPS 프로토콜을 사용하고 도메인 이름을 포함해야 하며 IP 주소 또는 localhost를 포함할 수 없습니다. token_type이 CODE인 경우 필수입니다.

TokenType

취소할 토큰의 유형입니다.

열거형
TOKEN_TYPE_UNSPECIFIED 기본값이며 사용할 수 없습니다.
REFRESH_TOKEN 토큰 유형은 refresh_token입니다.
ACCESS_TOKEN 토큰 유형은 access_token입니다.
CODE 토큰 유형은 authorization_code입니다.

RevokeTokenResponse

이 유형에는 필드가 없습니다.

RevokeToken의 응답 메시지입니다. 지금은 비워 둡니다.

StartMfaEnrollmentRequest

사용자의 MFA 등록 인증 SMS를 전송합니다.

필드
id_token

string

필수 입력란입니다. 사용자의 ID 토큰입니다.

tenant_id

string

MFA를 등록하는 사용자가 속한 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자는 기본 Identity Platform 프로젝트에 속합니다.

통합 필드 enrollment_info. 보조 인증 수단 유형별 MFA 정보 enrollment_info은 다음 중 하나여야 합니다.
phone_enrollment_info

StartMfaPhoneRequestInfo

전화 인증을 위한 SMS 전송을 승인하는 인증 정보입니다.

totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

TOTP 인증과 관련된 로그인 정보입니다.

StartMfaEnrollmentResponse

StartMfaEnrollment 응답

필드
통합 필드 enrollment_response. MFA 시작 등록 응답(2차 요소 유형별) enrollment_response은 다음 중 하나여야 합니다.
phone_session_info

StartMfaPhoneResponseInfo

전화 인증을 위한 SMS 전송을 승인하는 인증 정보입니다.

totp_session_info

StartMfaTotpEnrollmentResponseInfo

TOTP 인증과 관련된 등록 응답 정보입니다.

StartMfaPhoneRequestInfo

StartMfa 요청의 앱 인증 정보입니다.

필드
phone_number

string

등록에 필요합니다. MFA로 등록할 전화번호입니다.

ios_receipt

string

iOS만 해당 APNS를 통한 앱 토큰 유효성 검사 성공 수신

ios_secret

string

iOS만 해당 APNS를 통해 iOS 앱에 전송된 보안 비밀

recaptcha_token

string

웹 전용 reCAPTCHA 솔루션

auto_retrieval_info

AutoRetrievalInfo

Android 전용입니다. Google Play 서비스에서 자동 검색을 위해 앱을 식별하는 데 사용됩니다.

safety_net_token

string

Android 전용입니다. recaptcha 토큰 대신 애플리케이션 ID를 어설션하는 데 사용됩니다. SafetyNet 토큰은 phone_number 필드의 Base64 인코딩을 nonce로 사용하여 SafetyNet Android Attestation API를 통해 생성할 수 있습니다.

play_integrity_token

string

Android 전용입니다. recaptcha 토큰 (또는 안전 그물 토큰) 대신 애플리케이션 ID를 어설션하는 데 사용됩니다. Play Integrity 토큰은 phone_number 필드에 SHA256을 nonce로 적용하여 PlayIntegrity API를 통해 생성할 수 있습니다.

captcha_response

string

reCAPTCHA 클라이언트 측 통합에서 제공하는 reCAPTCHA Enterprise 토큰입니다. reCAPTCHA Enterprise가 사용 설정된 경우 필요합니다.

client_type

ClientType

클라이언트 유형(웹, Android 또는 iOS) reCAPTCHA Enterprise가 사용 설정된 경우 필요합니다.

recaptcha_version

RecaptchaVersion

captcha_response의 reCAPTCHA 토큰의 reCAPTCHA 버전입니다. reCAPTCHA Enterprise가 사용 설정된 경우 필요합니다.

StartMfaPhoneResponseInfo

StartMfa 응답의 전화 인증 정보입니다.

필드
session_info

string

등록 세션을 나타내는 불투명 문자열입니다.

StartMfaSignInRequest

다중 인증 챌린지를 전송하여 다중 인증 로그인을 시작합니다.

필드
mfa_pending_credential

string

필수 입력란입니다. 첫 번째 단계 로그인에서 대기 중인 사용자 인증 정보

mfa_enrollment_id

string

필수 입력란입니다. 사용자의 현재 MFA 등록 목록에 있는 MFA 등록 ID입니다.

tenant_id

string

사용자가 로그인하는 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자가 기본 Identity Platform 프로젝트에 로그인합니다.

통합 필드 sign_in_info. 보조 인증 수단 유형별 MFA 정보 sign_in_info은 다음 중 하나여야 합니다.
phone_sign_in_info

StartMfaPhoneRequestInfo

전화 인증을 위한 SMS 전송을 승인하는 인증 정보입니다.

StartMfaSignInResponse

StartMfaSignIn 응답

필드
통합 필드 response_info. MultiFactor가 두 번째 요소 유형별로 로그인 응답을 시작합니다. response_info은 다음 중 하나여야 합니다.
phone_response_info

StartMfaPhoneResponseInfo

SMS 유형의 두 번째 단계에 관한 다중 인증 로그인 세션 정보입니다. 전송된 SMS에서 가져온 일회성 코드와 함께 이 세션 정보의 콘텐츠를 FinalizeMfaSignIn에 전달하여 로그인을 완료해야 합니다.

StartMfaTotpEnrollmentRequestInfo

이 유형에는 필드가 없습니다.

StartMfa의 TOTP 인증과 관련된 MFA 요청 정보입니다.

StartMfaTotpEnrollmentResponseInfo

StartMfa의 TOTP 인증과 관련된 MFA 응답 정보입니다.

필드
shared_secret_key

string

공유된 TOTP 보안 비밀을 나타내는 base 32 인코딩 문자열입니다.

base 32 인코딩은 RFC4648#section-6에 지정된 인코딩입니다. (이는 RFC3548#section-5의 base 32 인코딩과 동일합니다.)

verification_code_length

int32

생성해야 하는 인증 코드의 길이입니다.

hashing_algorithm

string

인증 코드를 생성하는 데 사용되는 해싱 알고리즘입니다.

period_sec

int32

인증 코드가 변경되는 시간(초)입니다.

session_info

string

등록 세션을 나타내는 인코딩된 문자열입니다.

finalize_enrollment_time

Timestamp

등록이 완료되어야 하는 시간입니다.

WithdrawMfaRequest

MFA를 철회합니다.

필드
id_token

string

필수 입력란입니다. 사용자의 ID 토큰입니다.

mfa_enrollment_id

string

필수 입력란입니다. 현재 MFA 등록의 MFA 등록 ID입니다.

tenant_id

string

사용자가 MFA 등록을 해제한 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자는 기본 Identity Platform 프로젝트에 속합니다.

WithdrawMfaResponse

MultiFactorAuth 응답을 철회합니다.

필드
id_token

string

두 번째 단계 삭제를 반영하도록 ID 토큰이 업데이트되었습니다.

refresh_token

string

인증 2단계 요소 삭제를 반영하도록 갱신 토큰이 업데이트되었습니다.