이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Method: accounts.sendOobCode

HTTP 요청
요청 본문
- JSON 표현
응답 본문
승인 범위
사용해 보기

계정에 대한 비표준 확인 코드를 전송합니다. 인증된 요청의 요청은 원하는 경우 OOB 코드를 전송하는 대신 OOB 코드가 포함된 링크를 반환할 수 있습니다.

HTTP 요청

POST https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현

JSON 표현
{ "requestType": enum (`OobReqType`), "email": string, "challenge": string, "captchaResp": string, "userIp": string, "newEmail": string, "idToken": string, "continueUrl": string, "iOSBundleId": string, "iOSAppStoreId": string, "androidPackageName": string, "androidInstallApp": boolean, "androidMinimumVersion": string, "canHandleCodeInApp": boolean, "tenantId": string, "targetProjectId": string, "dynamicLinkDomain": string, "returnOobLink": boolean, "clientType": enum (`ClientType`), "recaptchaVersion": enum (`RecaptchaVersion`), "linkDomain": string }

{
  "requestType": enum (OobReqType),
  "email": string,
  "challenge": string,
  "captchaResp": string,
  "userIp": string,
  "newEmail": string,
  "idToken": string,
  "continueUrl": string,
  "iOSBundleId": string,
  "iOSAppStoreId": string,
  "androidPackageName": string,
  "androidInstallApp": boolean,
  "androidMinimumVersion": string,
  "canHandleCodeInApp": boolean,
  "tenantId": string,
  "targetProjectId": string,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}

필드
`requestType`	`enum (OobReqType)` 필수 입력란입니다. 전송할 비표준 (OOB) 코드의 유형입니다. 이 값에 따라 이 요청의 다른 필드가 필요하거나 다른 의미를 갖게 됩니다. 전송할 수 있는 OOB 코드에는 4가지가 있습니다. * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
`email`	`string` OOB 코드를 전송할 계정의 이메일 주소이며 일반적으로 업데이트해야 하는 계정의 이메일 주소입니다. PASSWORD_RESET, EMAIL_SIGNIN, VERIFY_EMAIL에 필요합니다. returnOobLink가 true로 설정된 경우 VERIFY_AND_CHANGE_EMAIL 요청에만 필요합니다. 이 경우 사용자의 원래 이메일입니다.
`challenge (deprecated)`	`string`
`captchaResp`	`string` PASSWORD_RESET 요청의 경우 시스템에서 악용 가능성이 있는 활동을 감지하면 reCaptcha 응답이 필요합니다. 이 경우 호출자를 인증하는 데 사용된 reCaptcha 챌린지의 응답입니다.
`userIp`	`string` 호출자의 IP 주소입니다. PASSWORD_RESET 요청에만 필요합니다.
`newEmail`	`string` 계정이 업데이트될 이메일 주소입니다. VERIFY_AND_CHANGE_EMAIL 요청에만 필요합니다.
`idToken`	`string` 계정의 ID 토큰입니다. returnOobLink가 true로 설정되지 않은 경우 VERIFY_AND_CHANGE_EMAIL 및 VERIFY_EMAIL 요청에 필요합니다.
`continueUrl`	`string` 사용자가 이메일로 전송된 링크를 클릭한 후 계속 진행할 URL입니다. 웹 위젯이 OOB 코드를 처리할 수 있는 URL입니다.
`iOSBundleId`	`string` 연결된 iOS 앱이 OOB 코드를 처리할 수 있는 경우 이 앱의 iOS 번들 ID입니다. 이렇게 하면 올바른 앱이 이미 설치되어 있는 경우 열 수 있습니다.
`iOSAppStoreId`	`string` 연결된 iOS 앱이 OOB 코드를 처리할 수 있는 경우 이 앱의 App Store ID입니다. 이렇게 하면 앱이 아직 설치되지 않은 경우 App Store가 올바른 앱으로 열립니다.
`androidPackageName`	`string` 연결된 Android 앱이 OOB 코드를 처리할 수 있는 경우 이 OOB 코드가 사용될 때 콜백을 처리할 Android 앱의 Android 패키지 이름입니다. 이렇게 하면 앱이 이미 설치된 경우 올바른 앱이 열리고, 아직 설치되지 않은 경우 Google Play 스토어에서 올바른 앱이 열립니다.
`androidInstallApp`	`boolean` 연결된 Android 앱이 OOB 코드를 처리할 수 있는 경우 앱이 아직 설치되지 않은 경우 링크가 열리는 기기에 Android 앱을 설치할지 여부입니다.
`androidMinimumVersion`	`string` 연결된 Android 앱이 OOB 코드를 처리할 수 있는 경우 앱의 최소 버전입니다. 기기의 버전이 이 버전보다 낮으면 사용자는 앱을 업그레이드하기 위해 Google Play 스토어로 이동합니다.
`canHandleCodeInApp`	`boolean` true로 설정하면 OOB 코드 링크가 범용 링크 또는 Android 앱 링크로 전송되고 앱이 설치된 경우 해당 앱에서 열립니다. 설정하지 않거나 false로 설정하면 OOB 코드가 먼저 웹 위젯에 전송되고 앱이 설치된 경우 계속해서 앱으로 리디렉션됩니다.
`tenantId`	`string` 계정이 속한 Identity Platform 테넌트의 테넌트 ID입니다.
`targetProjectId`	`string` 계정이 속한 Identity Platform 프로젝트의 프로젝트 ID입니다. 이 필드를 지정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다. 승인을 처리하려면 지정된 리소스 `targetProjectId`에 대해 다음과 같은 IAM 권한이 필요합니다. `firebaseauth.users.sendEmail`
`dynamicLinkDomain`	`string` 사용된 URL을 iOS 또는 Android에서 쉽게 열 수 있도록 Firebase 동적 링크를 만듭니다. 대부분의 Identity Platform 프로젝트에는 동적 링크 도메인이 하나만 사용 설정되며 이 필드는 비워 둘 수 있습니다. 이 필드에는 동적 링크가 여러 개 사용 설정된 프로젝트의 지정된 동적 링크 도메인이 포함됩니다.
`returnOobLink`	`boolean` OOB 코드가 포함된 확인 링크를 응답으로 반환해야 하는지 여부입니다 (이메일은 전송되지 않음). 개발자가 이메일 템플릿을 직접 구성하고 전송하려는 경우에 사용됩니다. 기본값은 false입니다. 이 필드를 지정하고 true로 설정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다.
`clientType`	`enum (ClientType)` 클라이언트 유형: 웹, Android 또는 iOS reCAPTCHA Enterprise 보호가 사용 설정된 경우 필요합니다.
`recaptchaVersion`	`enum (RecaptchaVersion)` captchaResponse의 reCAPTCHA 토큰의 reCAPTCHA 버전입니다.
`linkDomain`	`string` 선택사항입니다. 사용되는 URL을 iOS 또는 Android에서 쉽게 열 수 있도록 호스팅 링크 '/__/auth/links'를 만듭니다. 이 선택사항 필드에는 호스팅 링크를 구성할 때 사용할 도메인이 포함됩니다. 설정하지 않으면 '.firebaseapp.com' 도메인이 사용됩니다.

응답 본문

성공한 경우 응답 본문에 GetOobCodeResponse의 인스턴스가 포함됩니다.

승인 범위

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

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

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