Method: accounts.mfaEnrollment.start

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

HTTP 요청

POST https://identitytoolkit.googleapis.com/v2/accounts/mfaEnrollment:start

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

요청 본문

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

JSON 표현 
{
  "idToken": string,
  "tenantId": string,

  // Union field enrollment_info can be only one of the following:
  "phoneEnrollmentInfo": {
    object (StartMfaPhoneRequestInfo)
  },
  "totpEnrollmentInfo": {
    object (StartMfaTotpEnrollmentRequestInfo)
  }
  // End of list of possible types for union field enrollment_info.
}
필드
idToken

string

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

string

MFA를 등록하는 사용자가 속한 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자는 기본 Identity Platform 프로젝트에 속합니다.
통합 필드 enrollment_info. 보조 인증 수단 유형별 MFA 정보 enrollment_info은 다음 중 하나여야 합니다.
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

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

object (StartMfaTotpEnrollmentRequestInfo)

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

응답 본문

mfaEnrollment.start 응답

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

JSON 표현 
{

  // Union field enrollment_response can be only one of the following:
  "phoneSessionInfo": {
    object (StartMfaPhoneResponseInfo)
  },
  "totpSessionInfo": {
    object (StartMfaTotpEnrollmentResponseInfo)
  }
  // End of list of possible types for union field enrollment_response.
}
필드
통합 필드 enrollment_response. MFA 시작 등록 응답(2차 요소 유형별) enrollment_response은 다음 중 하나여야 합니다.
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

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

object (StartMfaTotpEnrollmentResponseInfo)

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

승인 범위

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

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

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

StartMfaTotpEnrollmentRequestInfo

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

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

StartMfaTotpEnrollmentResponseInfo

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

JSON 표현 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
필드
sharedSecretKey

string

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

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

integer

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

string

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

integer

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

string

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

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"입니다.