새 이메일 및 비밀번호 사용자 또는 익명 사용자를 가입 처리하거나 익명 사용자를 이메일 및 비밀번호로 업그레이드합니다. 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 포함된 관리자 요청의 경우 새 익명 사용자, 이메일 및 비밀번호 또는 전화번호 사용자를 만듭니다.
Google Cloud 프로젝트를 식별하려면 요청에 API 키가 필요합니다.
HTTP 요청
POST https://identitytoolkit.googleapis.com/v1/accounts:signUp
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "email": string, "password": string, "displayName": string, "captchaChallenge": string, "captchaResponse": string, "instanceId": string, "idToken": string, "emailVerified": boolean, "photoUrl": string, "disabled": boolean, "localId": string, "phoneNumber": string, "tenantId": string, "targetProjectId": string, "mfaInfo": [ { object ( |
필드 | |
---|---|
email |
생성된 사용자에게 할당할 이메일입니다. 이메일 길이는 256자(영문 기준) 미만이어야 하며 |
password |
생성된 사용자에게 할당할 비밀번호입니다. 비밀번호는 6자(영문 기준) 이상이어야 합니다. 설정된 경우 |
displayName |
만들려는 사용자의 표시 이름입니다. |
captchaChallenge |
|
captchaResponse |
reCAPTCHA 클라이언트 측 통합에서 제공하는 reCAPTCHA 토큰입니다. reCAPTCHA Enterprise에서 평가에 사용합니다. reCAPTCHA Enterprise가 사용 설정된 경우 필요합니다. |
instanceId |
|
idToken |
Identity Platform 사용자의 유효한 ID 토큰입니다. 이 요청을 설정하면 인증 사용자 인증 정보가 이 ID 토큰으로 표현된 사용자에게 연결됩니다. 비관리자 요청의 경우 |
emailVerified |
사용자의 이메일이 확인되었는지 여부입니다. 이 필드를 지정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다. |
photoUrl |
생성할 사용자의 프로필 사진 URL입니다. |
disabled |
생성 시 사용자를 사용 중지할지 여부입니다. 적절한 권한이 있는 Google OAuth2 사용자 인증 정보가 포함된 요청을 제외하고 사용 중지된 계정에는 액세스할 수 없습니다. |
localId |
생성할 사용자의 ID입니다. ID는 사용자가 생성되는 프로젝트 내에서 고유해야 합니다. 이 필드를 지정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다. |
phoneNumber |
생성할 사용자의 전화번호입니다. 이 필드를 지정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다. |
tenantId |
사용자를 만들 Identity Platform 테넌트의 ID입니다. 설정하지 않으면 기본 Identity Platform 프로젝트 아래에 사용자가 생성됩니다. |
targetProjectId |
사용자가 속해야 하는 프로젝트의 프로젝트 ID입니다. 이 필드를 지정하려면 적절한 권한이 있는 Google OAuth 2.0 사용자 인증 정보가 필요합니다. 이 값을 설정하지 않으면 대상 프로젝트가 Bearer 액세스 토큰과 연결된 범위에서 추론됩니다. |
mfaInfo[] |
사용자가 만들 수 있는 다중 인증 제공업체입니다. |
clientType |
클라이언트 유형: 웹, Android 또는 iOS reCAPTCHA Enterprise 보호를 사용 설정할 때 필요합니다. |
recaptchaVersion |
captchaResponse의 reCAPTCHA 토큰의 reCAPTCHA 버전입니다. |
응답 본문
성공한 경우 응답 본문에 SignUpResponse
의 인스턴스가 포함됩니다.
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
자세한 내용은 Authentication Overview를 참고하세요.