Config

Identity Toolkit 프로젝트를 나타냅니다.

JSON 표현 
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
필드
name

string

출력 전용입니다. 구성 리소스의 이름입니다. 예: 'projects/my-awesome-project/config'
signIn

object (SignInConfig)

로컬 로그인 방법과 관련된 구성입니다.
notification

object (NotificationConfig)

사용자에게 알림을 보내는 것과 관련된 구성
quota

object (QuotaConfig)

할당량과 관련된 구성입니다.
monitoring

object (MonitoringConfig)

프로젝트 활동 모니터링과 관련된 구성입니다.
multiTenant

object (MultiTenantConfig)

멀티 테넌트 기능과 관련된 구성입니다.
authorizedDomains[]

string

OAuth 리디렉션에 승인된 도메인 목록
subtype

enum (Subtype)

출력 전용입니다. 이 구성의 하위유형입니다.
client

object (ClientConfig)

프로젝트를 대신하여 요청을 실행하는 클라이언트를 구성하는 방법과 관련된 옵션입니다.
mfa

object (MultiFactorAuthConfig)

이 프로젝트의 다중 인증 구성(활성 상태 여부, 보조 인증에 사용할 수 있는 인증 요소 포함)
blockingFunctions

object (BlockingFunctionsConfig)

차단 함수와 관련된 구성입니다.
recaptchaConfig

object (RecaptchaConfig)

프로젝트 수준 reCAPTCHA 구성입니다.
smsRegionConfig

object (SmsRegionConfig)

SMS 인증 코드 전송이 사용 설정된 리전을 구성합니다.
autodeleteAnonymousUsers

boolean

익명 사용자를 30일 후에 자동으로 삭제할지 여부입니다.
passwordPolicyConfig

object (PasswordPolicyConfig)

프로젝트 수준 비밀번호 정책 구성입니다.
emailPrivacyConfig

object (EmailPrivacyConfig)

이메일 개인 정보 보호 및 공개 상태와 관련된 설정 구성
defaultHostingSite

string

출력 전용입니다. 기본 Firebase 호스팅 사이트 이름

SignInConfig

로컬 로그인 방법과 관련된 구성입니다.

JSON 표현 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
필드
email

object (Email)

이메일 주소로 사용자를 인증하는 것과 관련된 구성 옵션입니다.
phoneNumber

object (PhoneNumber)

전화번호로 사용자를 인증하는 것과 관련된 구성 옵션입니다.
anonymous

object (Anonymous)

익명 사용자 인증과 관련된 구성 옵션입니다.
allowDuplicateEmails

boolean

두 개 이상의 계정에 동일한 이메일을 허용할지 여부입니다.
hashConfig

object (HashConfig)

출력 전용입니다. 구성 정보 해시

이메일

이메일 주소로 사용자를 인증하는 것과 관련된 구성 옵션입니다.

JSON 표현 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
필드
enabled

boolean

프로젝트에 이메일 인증이 사용 설정되어 있는지 여부입니다.
passwordRequired

boolean

이메일 인증에 비밀번호가 필요한지 여부입니다. 이 값이 true인 경우 로그인하려면 이메일과 비밀번호를 모두 입력해야 합니다. false인 경우 사용자는 이메일/비밀번호 또는 이메일 링크를 통해 로그인할 수 있습니다.

PhoneNumber

전화번호로 사용자를 인증하는 것과 관련된 구성 옵션입니다.

JSON 표현 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
필드
enabled

boolean

프로젝트에 전화번호 인증이 사용 설정되어 있는지 여부입니다.
testPhoneNumbers

map (key: string, value: string)

전화 인증 테스트에 사용할 수 있는 <테스트 전화번호, 가짜 코드> 맵

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

익명

익명 사용자 인증과 관련된 구성 옵션입니다.

JSON 표현 
{
  "enabled": boolean
}
필드
enabled

boolean

프로젝트에 익명 사용자 인증이 사용 설정되어 있는지 여부입니다.

NotificationConfig

사용자에게 알림을 보내는 것과 관련된 구성

JSON 표현 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
필드
sendEmail

object (SendEmail)

이메일 전송 옵션
sendSms

object (SendSms)

SMS 전송 옵션
defaultLocale

string

IETF BCP 47 형식의 이메일 및 SMS에 사용되는 기본 언어입니다.

SendEmail

이메일 전송 옵션

JSON 표현 
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
필드
method

enum (Method)

이메일을 보내는 데 사용되는 방법입니다.
resetPasswordTemplate

object (EmailTemplate)

비밀번호 재설정 이메일 템플릿
verifyEmailTemplate

object (EmailTemplate)

이메일 인증을 위한 이메일 템플릿
changeEmailTemplate

object (EmailTemplate)

변경 이메일용 이메일 템플릿
legacyResetPasswordTemplate

object (EmailTemplate)

기존 Firebase V1 앱의 비밀번호 재설정 이메일 템플릿
callbackUri

string

이메일 템플릿의 작업 URL
dnsInfo

object (DnsInfo)

커스텀 도메인 DNS 확인 정보
revertSecondFactorAdditionTemplate

object (EmailTemplate)

두 번째 단계 추가 이메일을 되돌리기 위한 이메일 템플릿
통합 필드 email_provider_config. 이메일 보내기에 사용되는 이메일 제공업체 구성 email_provider_config은 다음 중 하나여야 합니다.
smtp

object (Smtp)

맞춤 SMTP 릴레이 사용

메서드

이메일을 보내는 데 사용되는 방법입니다.

열거형
METHOD_UNSPECIFIED 이메일 방법이 지정되지 않았습니다.
DEFAULT 개발자를 대신하여 이메일을 보냅니다.
CUSTOM_SMTP 개발자가 제공한 SMTP 구성을 사용하여 이메일을 전송합니다.

Smtp

SMTP 릴레이 구성

JSON 표현 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
필드
senderEmail

string

SMTP 릴레이의 발신자 이메일
host

string

SMTP 릴레이 호스트
port

integer

SMTP 릴레이 포트
username

string

SMTP 릴레이 사용자 이름
password

string

SMTP 릴레이 비밀번호
securityMode

enum (SecurityMode)

SMTP 보안 모드

SecurityMode

SMTP 보안 모드

열거형
SECURITY_MODE_UNSPECIFIED 기본값 사용하지 마세요.
SSL SSL 모드
START_TLS START_TLS 모드

EmailTemplate

이메일 템플릿 제목 및 본문 입력란에는 다음 자리표시자가 포함될 수 있으며, 이 자리표시자는 적절한 값으로 대체됩니다. %LINK% - 전송 OOB 코드를 사용할 때 사용할 링크입니다. %EMAIL% - 이메일이 전송되는 이메일입니다. %NEW_EMAIL% - 계정에 설정되는 새 이메일입니다 (해당하는 경우). %APP_NAME% - Google Cloud 프로젝트의 표시 이름입니다. %DISPLAY_NAME% - 사용자의 표시 이름입니다.

JSON 표현 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
필드
senderLocalPart

string

보낸사람 주소의 로컬 부분
subject

string

이메일 제목
senderDisplayName

string

발신자 표시 이름
body

string

이메일 본문
bodyFormat

enum (BodyFormat)

이메일 본문 형식
replyTo

string

답장받을 주소
customized

boolean

출력 전용입니다. 이메일의 본문 또는 제목이 맞춤설정되어 있는지 여부입니다.

BodyFormat

이메일 본문 형식

열거형
BODY_FORMAT_UNSPECIFIED 기본값 사용하지 마세요.
PLAIN_TEXT 일반 텍스트
HTML HTML

DnsInfo

커스텀 도메인 DNS 확인 정보 기본적으로 default_domain이 사용됩니다. VerifyCustomDomain을 사용하여 커스텀 도메인을 구성할 수 있습니다.

JSON 표현 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
필드
customDomain

string

출력 전용입니다. 적용된 인증된 커스텀 도메인입니다.
useCustomDomain

boolean

커스텀 도메인 사용 여부입니다.
pendingCustomDomain

string

출력 전용입니다. 확인할 커스텀 도메인입니다.
customDomainState

enum (VerificationState)

출력 전용입니다. 커스텀 도메인의 현재 인증 상태입니다. 맞춤 도메인은 도메인 인증이 완료된 후에만 사용됩니다.
domainVerificationRequestTime

string (Timestamp format)

출력 전용입니다. 현재 도메인 확인을 위한 최초 요청의 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

SendSms

SMS 전송 옵션

JSON 표현 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
필드
useDeviceLocale

boolean

SMS에 accept_language 헤더를 사용할지 여부입니다.
smsTemplate

object (SmsTemplate)

출력 전용입니다. SMS를 보낼 때 사용할 템플릿입니다.

SmsTemplate

SMS를 보낼 때 사용할 템플릿입니다.

JSON 표현 
{
  "content": string
}
필드
content

string

출력 전용입니다. SMS의 콘텐츠입니다. 다음 자리표시자를 포함할 수 있으며, 이러한 자리표시자는 적절한 값으로 대체됩니다. %APP_NAME% - Android 또는 iOS 앱의 경우 앱의 표시 이름입니다. 웹 앱의 경우 애플리케이션을 호스팅하는 도메인입니다. %LOGIN_CODE% - SMS로 전송되는 OOB 코드입니다.

QuotaConfig

할당량과 관련된 구성입니다.

JSON 표현 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
필드
signUpQuotaConfig

object (TemporaryQuota)

덮어쓴 경우 가입 엔드포인트의 할당량입니다. 가입 할당량은 IP별 시간당 프로젝트당 가입 건수로 측정됩니다.

TemporaryQuota

일시적인 할당량 증가 / 감소

JSON 표현 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
필드
quota

string (int64 format)

QuotaServer 구성의 'refill_token_count' 필드에 해당합니다.
startTime

string (Timestamp format)

이 할당량이 적용되는 시점

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
quotaDuration

string (Duration format)

이 할당량이 활성 상태로 유지되는 기간

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.

MultiTenantConfig

멀티 테넌트 기능과 관련된 구성입니다.

JSON 표현 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
필드
allowTenants

boolean

이 프로젝트에 테넌트가 있을 수 있는지 여부입니다.
defaultTenantLocation

string

테넌트 프로젝트를 만들어야 하는 기본 클라우드 상위 조직 또는 폴더입니다. 상위 리소스 이름은 '/' 형식이어야 합니다(예: 'folders/123' 또는 'organizations/456'). 값을 설정하지 않으면 테넌트가 상담사 프로젝트와 동일한 조직 또는 폴더 아래에 생성됩니다.

하위 유형

이 구성의 하위유형입니다.

열거형
SUBTYPE_UNSPECIFIED 기본값 사용하지 마세요.
IDENTITY_PLATFORM Identity Platform 프로젝트
FIREBASE_AUTH Firebase 인증 프로젝트

ClientConfig

프로젝트를 대신하여 요청을 실행하는 클라이언트를 구성하는 방법과 관련된 옵션입니다.

JSON 표현 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
필드
apiKey

string

출력 전용입니다. 이 프로젝트에 대한 요청을 할 때 사용할 수 있는 API 키입니다.
permissions

object (Permissions)

사용자가 계정에 영향을 미치는 기능을 제한하는 것과 관련된 구성입니다.
firebaseSubdomain

string

출력 전용입니다. Firebase 하위 도메인

권한

사용자가 계정에 영향을 미치는 기능을 제한하는 것과 관련된 구성입니다.

JSON 표현 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
필드
disabledUserSignup

boolean

true인 경우 최종 사용자는 API 메서드를 통해 연결된 프로젝트에서 새 계정에 가입할 수 없습니다.
disabledUserDeletion

boolean

이 속성이 true이면 최종 사용자가 API 메서드를 통해 연결된 프로젝트에서 자신의 계정을 삭제할 수 없습니다.

BlockingFunctionsConfig

차단 함수와 관련된 구성입니다.

JSON 표현 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
필드
triggers

map (key: string, value: object (Trigger))

트리거와 이벤트 유형의 매핑입니다. 키는 지원되는 이벤트 유형(예: 'beforeCreate', 'beforeSignIn') 중 하나여야 합니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
forwardInboundCredentials

object (ForwardInboundCredentials)

등록된 차단 함수로 전송되는 JWT 페이로드에 포함할 사용자 인증 정보입니다.

트리거

HTTP 트리거를 사용하는 동기식 Cloud 함수

JSON 표현 
{
  "functionUri": string,
  "updateTime": string
}
필드
functionUri

string

Cloud 함수의 HTTP URI 트리거입니다.
updateTime

string (Timestamp format)

트리거가 변경된 시점입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 자릿수가 0, 3, 6 또는 9인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

ForwardInboundCredentials

등록된 차단 함수에 전달할 사용자 인증 정보를 나타냅니다.

JSON 표현 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
필드
idToken

boolean

사용자의 OIDC ID 공급업체 ID 토큰을 전달할지 여부입니다.
accessToken

boolean

사용자의 OAuth ID 공급업체 액세스 토큰을 전달할지 여부입니다.
refreshToken

boolean

사용자의 OAuth ID 공급업체 갱신 토큰을 전달할지 여부입니다.