Esta página foi traduzida pela API Cloud Translation.

Method: accounts.signUp

Solicitação HTTP
Corpo da solicitação
- Representação JSON
Corpo da resposta
Escopos de autorização
Faça um teste

Registra um novo usuário com e-mail e senha ou um usuário anônimo ou faz upgrade de um usuário anônimo para um usuário com e-mail e senha. Para uma solicitação de administrador com uma credencial do Google OAuth 2.0 com as permissões adequadas, cria um novo usuário anônimo, de e-mail e senha ou de número de telefone.

Uma chave de API é necessária na solicitação para identificar o projeto do Google Cloud.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON

Representação 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 (`MfaFactor`) } ], "clientType": enum (`ClientType`), "recaptchaVersion": enum (`RecaptchaVersion`) }

{
  "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 (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}

Campos
`email`	`string` O e-mail a ser atribuído ao usuário criado. O e-mail precisa ter menos de 256 caracteres e estar no formato `name@domain.tld`. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Um usuário anônimo será criado se não for fornecido.
`password`	`string` A senha a ser atribuída ao usuário criado. A senha precisa ter pelo menos seis caracteres. Se definido, o campo `email` também precisa ser definido.
`displayName`	`string` O nome de exibição do usuário a ser criado.
`captchaChallenge (deprecated)`	`string`
`captchaResponse`	`string` O token reCAPTCHA fornecido pela integração do reCAPTCHA no lado do cliente. O reCAPTCHA Enterprise o usa para avaliação. Obrigatório quando o reCAPTCHA Enterprise está ativado.
`instanceId (deprecated)`	`string`
`idToken`	`string` Um token de ID válido para um usuário do Identity Platform. Se definido, essa solicitação vai vincular a credencial de autenticação ao usuário representado por esse token de ID. Para uma solicitação que não seja de administrador, os campos `email` e `password` precisam ser definidos. Para uma solicitação de administrador, `localId` não pode ser definido.
`emailVerified`	`boolean` Indica se o e-mail do usuário foi verificado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.
`photoUrl`	`string` O URL da foto do perfil do usuário a ser criado.
`disabled`	`boolean` Indica se o usuário será desativado após a criação. As contas desativadas ficam inacessíveis, exceto para solicitações com uma credencial do Google OAuth2 com as permissões adequadas.
`localId`	`string` O ID do usuário a ser criado. O ID precisa ser exclusivo no projeto em que o usuário está sendo criado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.
`phoneNumber`	`string` O número de telefone do usuário a ser criado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.
`tenantId`	`string` O ID do locatário do Identity Platform para criar um usuário. Se não for definido, o usuário será criado no projeto padrão do Identity Platform.
`targetProjectId`	`string` O ID do projeto ao qual o usuário precisa pertencer. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas. Se não for definido, o projeto de destino será inferido do escopo associado ao token de acesso Bearer.
`mfaInfo[]`	`object (MfaFactor)` Os provedores de autenticação multifator que o usuário vai criar.
`clientType`	`enum (ClientType)` O tipo de cliente: Web, Android ou iOS. Obrigatório ao ativar a proteção do reCAPTCHA Enterprise.
`recaptchaVersion`	`enum (RecaptchaVersion)` A versão do reCAPTCHA do token reCAPTCHA no captchaResponse.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SignUpResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.