이메일 링크의 대역 외 코드로 사용자를 로그인 또는 가입 처리합니다. 지정된 이메일 주소로 사용자가 존재하지 않으면 사용자 레코드가 생성됩니다. 로그인이 성공하면 인증된 사용자에게 Identity Platform ID 및 갱신 토큰이 발급됩니다.
Google Cloud 프로젝트를 식별하려면 요청에 API 키가 필요합니다.
HTTP 요청
POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithEmailLink
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string } |
필드 | |
---|---|
oobCode |
필수 입력란입니다. 이메일 링크의 대역 외 코드입니다. |
email |
필수 입력란입니다. 로그인 링크가 전송된 이메일 주소입니다. 이메일 길이는 256자(영문 기준) 미만이어야 하며 |
idToken |
Identity Platform 계정의 유효한 ID 토큰입니다. 요청이 통과되면 이메일 주소가 이 ID 토큰으로 표현된 사용자에게 연결되고 향후 계정에서 이메일 링크로 로그인이 사용 설정됩니다. |
tenantId |
사용자가 로그인하는 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 사용자가 기본 Identity Platform 프로젝트에 로그인합니다. |
응답 본문
accounts.signInWithEmailLink의 응답 메시지입니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{
"kind": string,
"idToken": string,
"email": string,
"refreshToken": string,
"expiresIn": string,
"localId": string,
"isNewUser": boolean,
"mfaPendingCredential": string,
"mfaInfo": [
{
object ( |
필드 | |
---|---|
kind |
|
idToken |
인증된 사용자의 Identity Platform ID 토큰입니다. |
email |
사용자가 로그인할 때 사용하는 이메일입니다. 응답에 항상 표시됩니다. |
refreshToken |
인증된 사용자의 갱신 토큰입니다. |
expiresIn |
ID 토큰이 만료될 때까지 남은 시간(초)입니다. |
localId |
인증된 사용자의 ID입니다. 응답에 항상 표시됩니다. |
isNewUser |
이 요청에 의해 인증된 사용자가 생성되었는지 여부입니다. |
mfaPendingCredential |
사용자가 첫 번째 요소 확인을 통과했음을 증명하는 역할을 하는 불투명 문자열입니다. |
mfaInfo[] |
사용 설정된 다중 인증 제공업체에 관한 정보 사용자가 다중 인증을 사용하여 로그인을 완료해야 하는 경우 표시합니다. |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
자세한 내용은 Authentication Overview를 참고하세요.