API REST do Firebase Auth

Trocar token personalizado por um ID e um token de atualização

Você pode trocar um token de autenticação personalizado por um ID e token e atualização emitindo uma solicitação POST HTTP para o endpoint verifyCustomToken de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"token":"[CUSTOM_TOKEN]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o token personalizado.

Exemplo de resposta

{
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Códigos de erro comuns:

• INVALID_CUSTOM_TOKEN: o formato do token personalizado está incorreto ou o token é inválido por algum motivo (por exemplo, expirou, assinatura inválida etc.)
• CREDENTIAL_MISMATCH: o token personalizado corresponde a um projeto diferente do Firebase.

Trocar um token de atualização por um token de ID

É possível atualizar um token de ID do Firebase emitindo uma solicitação POST ao endpoint securetoken.googleapis.com.

Método: POST

Tipos de conteúdo: application/x-www-form-urlencoded

https://securetoken.googleapis.com/v1/token?key=[API_KEY]

Exemplo de solicitação

curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o novo token de ID do Firebase e o token de atualização.

Exemplo de resposta

{
  "expires_in": "3600",
  "token_type": "Bearer",
  "refresh_token": "[REFRESH_TOKEN]",
  "id_token": "[ID_TOKEN]",
  "user_id": "tRcfmLH7o2XrNELi...",
  "project_id": "1234567890"
}

Códigos de erro comuns:

• TOKEN_EXPIRED: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• USER_DISABLED: a conta de usuário foi desativada por um administrador.
• USER_NOT_FOUND: o usuário correspondente ao token de atualização não foi encontrado. É provável que o usuário tenha sido excluído.
• Chave de API inválida. Passe uma chave de API válida. (chave de API inválida fornecida)
• INVALID_REFRESH_TOKEN: um token de atualização inválido é fornecido.
• O payload JSON recebido é inválido. Nome desconhecido \"refresh_tokens\": não é possível vincular o parâmetro de consulta. O campo "refresh_tokens" não foi encontrado na mensagem de solicitação.
• INVALID_GRANT_TYPE: o tipo de concessão especificado é inválido.
• MISSING_REFRESH_TOKEN: nenhum token de atualização foi fornecido.
• PROJECT_NUMBER_MISMATCH: o número do projeto do token de atualização não corresponde ao da chave de API fornecida.

Inscreva-se com e-mail/senha

É possível criar um novo usuário de e-mail e senha emitindo uma solicitação HTTP POST para o endpoint signupNewUser de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com a nova conta.

Exemplo de resposta

{
  "idToken": "[ID_TOKEN]",
  "email": "[user@example.com]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "tRcfmLH7..."
}

Códigos de erro comuns:

• EMAIL_EXISTS: o endereço de e-mail já está sendo usado por outra conta.
• OPERATION_NOT_ALLOWED: o login por senha está desativado para este projeto.
• TOO_MANY_ATTEMPTS_TRY_LATER: bloqueamos todas as solicitações deste dispositivo devido a atividades incomuns. Tente mais tarde.

Fazer login com e-mail/senha

É possível fazer login de um usuário com um e-mail e senha emitindo uma solicitação HTTP POST para o endpoint verifyPassword de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com a conta de e-mail/senha existente.

Exemplo de resposta

{
  "localId": "ZY1rJK0eYLg...",
  "email": "[user@example.com]",
  "displayName": "",
  "idToken": "[ID_TOKEN]",
  "registered": true,
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Códigos de erro comuns:

• EMAIL_NOT_FOUND: não há registro de usuário correspondente a este identificador. O usuário pode ter sido excluído.
• INVALID_PASSWORD: a senha é inválida ou o usuário não tem uma senha.
• USER_DISABLED: a conta de usuário foi desativada por um administrador.

Fazer login anonimamente

É possível fazer login de um usuário anonimamente emitindo uma solicitação HTTP POST para o endpoint signupNewUser de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário anônimo.

Exemplo de resposta

{
  "idToken": "[ID_TOKEN]",
  "email": "",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "Jws4SVjpT..."
}

Códigos de erro comuns:

• OPERATION_NOT_ALLOWED: o login anônimo de usuário está desativado para este projeto.

Fazer login com a credencial OAuth

É possível fazer login de um usuário com uma credencial OAuth enviando uma solicitação HTTP POST para o endpoint verifyAssertion de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Exemplo de solicitação com token de ID do OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com token de ID do OAuth

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Exemplo de solicitação com token de acesso OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com o token de acesso OAuth

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Exemplo de solicitação com credencial do Twitter OAuth 1.0

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com credencial OAuth do Twitter 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Códigos de erro comuns:

• OPERATION_NOT_ALLOWED: o provedor correspondente está desativado para este projeto.
• INVALID_IDP_RESPONSE: a credencial de autenticação fornecida é inválida ou expirou.

Buscar provedores de e-mail

É possível procurar todos os provedores associados a um e-mail especificado enviando uma solicitação HTTP POST para o endpoint de createAuthUri de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém a lista de provedores associados ao e-mail.

Exemplo de resposta:

{
  "allProviders": [
    "password",
    "google.com"
  ],
  "registered": true
}

Códigos de erro comuns:

• INVALID_EMAIL: o endereço de e-mail está formatado incorretamente.

Enviar e-mail de redefinição de senha

É possível enviar um e-mail de redefinição de senha enviando uma solicitação POST HTTP para o endpoint getOobConfirmationCode de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
 "email": "[user@example.com]"
}

Códigos de erro comuns:

• EMAIL_NOT_FOUND: não há registro de usuário correspondente a este identificador. O usuário pode ter sido excluído.

Verificar o código de redefinição de senha

É possível verificar um código de redefinição de senha emitindo uma solicitação HTTP POST para o endpoint resetPassword de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Códigos de erro comuns:

• OPERATION_NOT_ALLOWED: o login por senha está desativado para este projeto.
• EXPIRED_OOB_CODE: o código da ação expirou.
• INVALID_ coB_CODE: o código de ação é inválido. Isso poderá acontecer se o código estiver incorreto, expirado ou já tiver sido usado.

Confirmar redefinição da senha

É possível aplicar uma alteração de redefinição de senha emitindo uma solicitação HTTP POST para o endpoint resetPassword de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Códigos de erro comuns:

• OPERATION_NOT_ALLOWED: o login por senha está desativado para este projeto.
• EXPIRED_OOB_CODE: o código da ação expirou.
• INVALID_ coB_CODE: o código de ação é inválido. Isso poderá acontecer se o código estiver incorreto, expirado ou já tiver sido usado.
• USER_DISABLED: a conta de usuário foi desativada por um administrador.

Alterar e-mail

É possível alterar o e-mail de um usuário emitindo uma solicitação HTTP POST para o endpoint setAccountInfo de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","email":"[user@example2.com]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o novo token de ID do Firebase e o token de atualização associados com o usuário.

Exemplo de resposta

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example2.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example2.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Códigos de erro comuns:

• EMAIL_EXISTS: o endereço de e-mail já está sendo usado por outra conta.
• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.

Alterar senha

É possível alterar a senha de um usuário emitindo uma solicitação HTTP POST para o endpoint de autenticação setAccountInfo.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","password":"[NEW_PASSWORD]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o novo token de ID do Firebase e o token de atualização associados com o usuário.

Exemplo de resposta

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• WEAK_PASSWORD: a senha precisa ter seis caracteres ou mais.

Atualizar perfil

É possível atualizar o perfil de um usuário (nome de exibição/URL da foto) enviando uma solicitação HTTP POST para o endpoint de autenticação setAccountInfo.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","displayName":"[NAME]","photoUrl":"[URL]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "localId": "tRcfmLH...",
  "email": "user@example2.com",
  "displayName": "John Doe",
  "photoUrl": "[http://localhost:8080/img1234567890/photo.png]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example2.com",
      "displayName": "John Doe",
      "photoUrl": "http://localhost:8080/img1234567890/photo.png"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.

Acessar dados do usuário

É possível receber os dados do usuário emitindo uma solicitação HTTP POST para o endpoint de autenticação getAccountInfo.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta conterá todas as informações do usuário associadas à conta.

Exemplo de resposta:

{
  "users": [
    {
      "localId": "ZY1rJK0...",
      "email": "user@example.com",
      "emailVerified": false,
      "displayName": "John Doe",
      "providerUserInfo": [
        {
          "providerId": "password",
          "displayName": "John Doe",
          "photoUrl": "http://localhost:8080/img1234567890/photo.png",
          "federatedId": "user@example.com",
          "email": "user@example.com",
          "rawId": "user@example.com",
          "screenName": "user@example.com"
        }
      ],
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
      "passwordHash": "...",
      "passwordUpdatedAt": 1.484124177E12,
      "validSince": "1484124177",
      "disabled": false,
      "lastLoginAt": "1484628946000",
      "createdAt": "1484124142000",
      "customAuth": false
    }
  ]
}

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• USER_NOT_FOUND: não há registros de usuário correspondentes a este identificador. O usuário pode ter sido excluído.

Vincular com e-mail/senha

É possível vincular um e-mail/senha a um usuário atual emitindo uma solicitação POST HTTP para o endpoint setAccountInfo de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","email":"[user@example.com]","password":"[PASS]","returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados ao usuário autenticado.

Exemplo de resposta

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "emailVerified": false
}

Códigos de erro comuns:

• CREDENTIAL_TOO_OLD_LOGIN_ASURE: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• TOKEN_EXPIRED: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• WEAK_PASSWORD: a senha precisa ter seis caracteres ou mais.

Vincular com a credencial OAuth

Você pode vincular uma credencial OAuth a um usuário emitindo uma solicitação HTTP POST para o endpoint de autenticação verifyAssertion.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Exemplo de solicitação com token de ID do OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com token de ID do OAuth

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Exemplo de solicitação com token de acesso OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com o token de acesso OAuth

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Exemplo de solicitação com credencial do Twitter OAuth 1.0

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK. A resposta contém o token de ID do Firebase e o token de atualização associados com o usuário autenticado.

Exemplo de resposta com credencial OAuth do Twitter 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Códigos de erro comuns:

• OPERATION_NOT_ALLOWED: o provedor correspondente está desativado para este projeto.
• INVALID_IDP_RESPONSE: a credencial de autenticação fornecida é inválida ou expirou.
• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• EMAIL_EXISTS: o endereço de e-mail já está sendo usado por outra conta.
• FEDERATED_USER_ID_ALREADY_LINKED: esta credencial já está associada a uma conta de usuário diferente.

Desvincular provedor

É possível desvincular um provedor de um usuário atual emitindo uma solicitação POST HTTP para o endpoint setAccountInfo de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"idToken":"[FIREBASE_ID_TOKEN]","deleteProvider":["[facebook.com]"]}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "google.com",
      "federatedId": "1234567890",
      "displayName": "John Doe",
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg"
    },
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "emailVerified": "true"
}

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.

Enviar verificação de e-mail

É possível enviar uma verificação de e-mail para o usuário atual emitindo uma solicitação POST HTTP para o endpoint getOobConfirmationCode de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "email": "user@example.com"
}

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• USER_NOT_FOUND: não há registros de usuário correspondentes a este identificador. O usuário pode ter sido excluído.

Confirmar a verificação por e-mail

Confirme um código de verificação de e-mail emitindo uma solicitação HTTP POST para o endpoint setAccountInfo de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Exemplo de resposta:

{
  "localId": "FhyStE...",
  "email": "user@example.com",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ]
}

Códigos de erro comuns:

• EXPIRED_OOB_CODE: o código da ação expirou.
• INVALID_ coB_CODE: o código de ação é inválido. Isso poderá acontecer se o código estiver incorreto, expirado ou já tiver sido usado.
• USER_DISABLED: a conta de usuário foi desativada por um administrador.
• EMAIL_NOT_FOUND: não há registro de usuário correspondente a este identificador. O usuário pode ter sido excluído.

Excluir conta

É possível excluir um usuário atual emitindo uma solicitação HTTP POST para o endpoint deleteAccount de autenticação.

Método: POST

Tipo de conteúdo: application/json

https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]

Exemplo de solicitação

curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Uma solicitação bem-sucedida é indicada por um código de status HTTP 200 OK.

Códigos de erro comuns:

• INVALID_ID_TOKEN: a credencial do usuário não é mais válida. O usuário precisa fazer login novamente.
• USER_NOT_FOUND: não há registros de usuário correspondentes a este identificador. O usuário pode ter sido excluído.

Limpar contas de usuário

Remove todas as contas no projeto especificado, independente do estado.

Método: DELETE

Observe que 9099 é a porta padrão do emulador do Authentication. Verificar terminal da porta que está sendo usada.

http://localhost:9099/emulator/v1/projects/{project-id}/accounts

Acessar configuração do emulador

Recebe a configuração específica do emulador para o projeto especificado.

Método: GET

Observe que 9099 é a porta padrão do emulador do Authentication. Verificar terminal da porta que está sendo usada.

http://localhost:9099/emulator/v1/projects/{project-id}/config

Fazer patch da configuração do emulador

Atualiza a configuração específica do emulador para o projeto especificado.

Método: PATCH

Observe que 9099 é a porta padrão do emulador do Authentication. Verificar terminal da porta que está sendo usada.

Tipo de conteúdo: application/json

http://localhost:9099/emulator/v1/projects/{project-id}/config

Extrair códigos de autenticação fora de banda

Se os fluxos de autenticação que você está testando normalmente geram códigos fora de banda (por exemplo, códigos de verificação de e-mail e de redefinição de senha), o emulador armazena esses códigos internamente até como eles são usados.

Método: GET

Observe que 9099 é a porta padrão do emulador do Authentication. Verificar terminal da porta que está sendo usada.

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes

Recuperar códigos de verificação por SMS

Se você estiver testando fluxos de autenticação por telefone/SMS, o emulador armazenará esses códigos SMS internamente até que sejam usados.

Método: GET

Observe que 9099 é a porta padrão do emulador do Authentication. Verificar terminal da porta que está sendo usada.

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes

Formato de resposta de erro

Sempre que um erro for retornado do servidor de back-end para qualquer uma das APIs acima, a resposta terá o formato a seguir.

Exemplo de resposta

{
  "error": {
    "errors": [
      {
        "domain": "global",
        "reason": "invalid",
        "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
      }
    ],
    "code": 400,
    "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
  }
}

O código do erro é encontrado no campo de mensagem. Todos os códigos de erro acima se referem do campo "message".