Registra un usuario nuevo con correo electrónico y contraseña o un usuario anónimo, o bien actualiza un usuario anónimo a correo electrónico y contraseña. Para una solicitud de administrador con una credencial de OAuth 2.0 de Google con los permisos adecuados, se crea un usuario anónimo nuevo con correo electrónico y contraseña, o número de teléfono.
Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.
Solicitud HTTP
POST https://identitytoolkit.googleapis.com/v1/accounts:signUp
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación 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 ( |
Campos | |
---|---|
email |
El correo electrónico que se asignará al usuario creado. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato |
password |
La contraseña que se asignará al usuario creado. La contraseña debe tener al menos 6 caracteres. Si se establece, también se debe establecer el campo |
displayName |
Es el nombre visible del usuario que se creará. |
captchaChallenge |
|
captchaResponse |
Es el token de reCAPTCHA que proporciona la integración del cliente de reCAPTCHA. reCAPTCHA Enterprise lo usa para la evaluación. Obligatorio cuando reCAPTCHA Enterprise está habilitado. |
instanceId |
|
idToken |
Un token de ID válido para un usuario de Identity Platform Si se establece, esta solicitud vinculará la credencial de autenticación al usuario representado por este token de ID. Para una solicitud que no sea de administrador, se deben configurar los campos |
emailVerified |
Indica si se verificó el correo electrónico del usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
photoUrl |
La URL de la foto de perfil del usuario que se creará. |
disabled |
Indica si el usuario se inhabilitará cuando se cree. No se puede acceder a las cuentas inhabilitadas, excepto para las solicitudes que tengan una credencial de OAuth2 de Google con los permisos adecuados. |
localId |
El ID del usuario que se creará. El ID debe ser único en el proyecto en el que se crea el usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
phoneNumber |
Es el número de teléfono del usuario que se creará. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. |
tenantId |
El ID del usuario de Identity Platform en el que se creará un usuario. Si no se establece, el usuario se creará en el proyecto predeterminado de Identity Platform. |
targetProjectId |
Es el ID del proyecto al que debe pertenecer el usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. Si no se establece, el proyecto de destino se infiere del alcance asociado al token de acceso de portador. |
mfaInfo[] |
Los proveedores de autenticación de varios factores que el usuario debe crear |
clientType |
El tipo de cliente: Web, Android o iOS Obligatorio cuando se habilita la protección de reCAPTCHA Enterprise. |
recaptchaVersion |
La versión de reCAPTCHA del token de reCAPTCHA en captchaResponse. |
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SignUpResponse
.
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulta Authentication Overview.