B4J Library [B4X] Firebase Auth REST API

Not all API commands I have implemented and tested, if you have problems, then ask in the comments or in a new thread.

With this class you can register and log in your users via email and password. And a lot more...

Setup:

1. put your API Key in the Class_Globals
   1. Private const API_KEY As String = "AIzaSyDPXXXXXX"

FirebaseAuthREST
Author: Alexander Stolte
Version: 1.1

• FirebaseAuthREST
  • Functions:
    • changeEmail (idToken As String, email As String, returnSecureToken As Boolean) As ResumableSub
      Change email
      

      Firebase Auth REST API

      firebase.google.com
      idToken - A Firebase Auth ID token for the user.
      email - The user's new email.
      returnSecureToken - Whether or not to return an ID and refresh token.
    • changePassword (idToken As String, password As String, returnSecureToken As Boolean) As ResumableSub
      Change password
      

      Firebase Auth REST API

      firebase.google.com
      idToken - A Firebase Auth ID token for the user.
      password - User's new password.
      returnSecureToken - Whether or not to return an ID and refresh token.
    • Class_Globals As String
    • confirmEmailVerification (oobCode As String) As ResumableSub
      Confirm email verification
      

      Firebase Auth REST API

      firebase.google.com
      oobCode - The action code sent to user's email for email verification.
    • confirmPasswordReset (oobCode As String, newPassword As String) As ResumableSub
      Confirm password reset
      

      Firebase Auth REST API

      firebase.google.com
      oobCode - The email action code sent to the user's email for resetting the password.
      newPassword - The user's new password.
    • createAuthUri (identifier As String, continueUri As String) As ResumableSub
      Fetch providers for email
      

      Firebase Auth REST API

      firebase.google.com
      identifier - User's email address
      continueUri - The URI to which the IDP redirects the user back. For this use case, this is just the current URL.
    • deleteAccount (idToken As String) As ResumableSub
      Delete account
      

      Firebase Auth REST API

      firebase.google.com
      idToken - The Firebase ID token of the user to delete.
    • getErrorCode (root As Map) As Int
      code: 400
    • getErrorMap (root As Map) As Map
      reason: invalid
      domain: global
      message: EMAIL_NOT_FOUND
    • getErrorMessage (root As Map) As String
      message: EMAIL_NOT_FOUND
    • Initialize As String
      Initializes the object. You can add parameters to this method if needed.
    • IsInitialized As Boolean
      Tests whether the object has been initialized.
    • sendEmailVerification (requestType As String, idToken As String) As ResumableSub
      Send email verification
      

      Firebase Auth REST API

      firebase.google.com
      requestType - The type of confirmation code to send. Should always be "VERIFY_EMAIL".
      idToken - The Firebase ID token of the user to verify.
    • sendPasswordResetEmail (requestType As String, email As String) As ResumableSub
      Send password reset email
      

      Firebase Auth REST API

      firebase.google.com
      requestType - The kind of OOB code to return. Should be "PASSWORD_RESET" for password reset.
      email - User's email address.
    • signInAnonymously (returnSecureToken As Boolean) As ResumableSub
      Sign in anonymously
      

      Firebase Auth REST API

      firebase.google.com
      returnSecureToken - Whether or not to return an ID and refresh token. Should always be true.
    • signInEmailPW (email As String, password As String, returnSecureToken As Boolean) As ResumableSub
      Sign in with email / password
      

      Firebase Auth REST API

      firebase.google.com
      email - The email the user is signing in with.
      password - The password for the account.
      returnSecureToken - Whether or not to return an ID and refresh token. Should always be true.
    • signUpEmailPW (email As String, password As String, returnSecureToken As Boolean) As ResumableSub
      Sign up with email / password
      

      Firebase Auth REST API

      firebase.google.com
      email - The email for the user to create.
      password - The password for the user to create.
      returnSecureToken - Whether or not to return an ID and refresh token. Should always be true.
    • verifyPasswordResetCode (oobCode As String) As ResumableSub
      Verify password reset code
      

      Firebase Auth REST API

      firebase.google.com
      oobCode - The email action code sent to the user's email for resetting the password.

You can get the map keys in the code or on the online documentation from Firebase

Firebase Auth REST API

firebase.google.com

[CODE lang="b4x" title="Usage Example"]Wait For (fa_rest.signInEmailPW("[email protected]","MySecurePassword123!",True)) complete (root As Map)

If root.Get("success") = True Then
For Each k As String In root.Keys
Log("Key: " & k & CRLF & "Value: " & root.Get(k))
Next
Else
Log("ErrorCode: " & fa_rest.getErrorCode(root))
Log("ErrorMessage: " & fa_rest.getErrorMessage(root))
Log("Reason: " & fa_rest.getErrorMap(root).Get("reason"))
Log("Domain: " & fa_rest.getErrorMap(root).Get("domain"))
Log("Message: " & fa_rest.getErrorMap(root).Get("message"))
End If[/CODE]
[CODE lang="b4x" title="Success Result"]Key: expiresIn
Value: 3600
Key: kind
Value: identitytoolkit#VerifyPasswordResponse
Key: displayName
Value:
Key: idToken
Value: eyJhbGciOiJSUzI1NiIsImtpZCI6Ijc2MjNlMTBhMDQ1MTQwZjFjZmQ0YmUwNDY2Y2Y4MDM1MmI1OWY4MWUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vZmlyLWF1dGhyZXN0IiwiYXVkIjoiZmlyLWF1dGhyZXN0IiwiYXV0aF90aW1lIjoxNTk0MjAxMzMxLCJ1c2VyX2lkIjoiSU90TjVqVmN1YWhjQWt2S0ExZWM0eDdPU0hHMiIsInN1YiI6IklPdE41alZjdWFoY0FrdktBMWVjNHg3T1NIRzIiLCJpYXQiOjE1OTQyMDEzMzEsImV4cCI6MTU5NDIwNDkzMSwiZW1haWwiOiJhbGV4Ljk4LnN0b2x0ZUBnbXguZGUiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJhbGV4Ljk4LnN0b2x0ZUBnbXguZGUiXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9fQ.PkoZaKyMxbz7U6s2fW2DQisGTgs5rbPJiqcJbVipopda1vi25iYGOyq0jDhaHdTFX4If_umKEsiRzWpncafKs7Kev1_aqDV-XAAHbEoO_zOyomsopRYIjzzL2NoUuSN-667ArzJURgA0VjB0s8GYN0hDeWqbISvq3Kgdu3569MQHDLd01BcFKc2-9Tv6ZoFGqsWTRWyZZmtu7PDga97vmsiQ01eiogmXY7giGbAMs4q9XdcP3vAzlYi8H5Tr61ywsKFhoPhhk6w4dH1o_RrErS5WiPKl-325QA-qZ99VBfMdgLoIyfCj898UbXP7cpq2E0vJrqMmdaALJsWfNhFzDg
Key: registered
Value: true
Key: localId
Value: IOtN5jVcuahcAkvKA1ec4x7OSHG2
Key: email
Value: [email protected]
Key: refreshToken
Value: AE0u-NcTYspSYujdVRs5Bx3eXMoVDeDRUNX3NGUd9xWfq-ty8r7NDeDvEhX14GGWeoXdWpzwT2oTkBGU5QCNdqhcipb_wCbDgIXX9IZ6lyatl_tCEfhupu5zYD3hnYDVetT2diHrxUZfwqUR-ZJBHUlDtA_3VkAAXNUdXhychL2pY7BELgawWOkrwDJbndMrdfGuyMDYDJ1mHTmUDLabouTDykvtmVo7rg
Key: success
Value: true[/CODE]
[CODE lang="b4x" title="Error Result"]
ErrorCode: 400
ErrorMessage: EMAIL_NOT_FOUND
Reason: invalid
Domain: global
Message: EMAIL_NOT_FOUND
[/CODE]
Changelog

• 1.00
  • Release
• 1.01
  • get Errors check if item in map exists
  • Add refreshToken - Exchange a refresh token for an ID token
• 1.02
  • Add getUserData - Thanks to @Blueforcer

Have Fun

 

[Alexander Stolte]

Update

• 1.01
  • get Errors check if item in map exists
  • Add refreshToken - Exchange a refresh token for an ID token

Firebase Auth REST API

firebase.google.com

[CODE lang="b4x" title="Usage"]Wait For (far.refreshToken("refresh_token",RefreshToken)) complete (root As Map)[/CODE]
[CODE lang="b4x" title="Result"]expires_in - The number of seconds in which the ID token expires.
token_type - The type of the refresh token, always "Bearer".
refresh_token - The Firebase Auth refresh token provided in the request or a new refresh token.
id_token - A Firebase Auth ID token.
user_id - The uid corresponding to the provided ID token.
project_id - Your Firebase project ID. [/CODE]

 

[Schakalaka]

Hello. is possible add facebook and google auth in this library?
i' d like to use it in b4j app and save the returned json, in a mysql database with php&co.

 

[Alexander Stolte]

Hello. is possible add facebook and google auth in this library?
i' d like to use it in b4j app

I don't know if is possible with the "SignInWithOAuth".

Firebase Auth REST API

firebase.google.com

But for these needs there are already B4A and B4I libraries.

 

[joulongleu]

@Alexander Stolte:Already Success Result: How to grab firebase database,Can you provide examples? Thank You.

 

[Alexander Stolte]

Already Success Result: How to grab firebase database,Can you provide examples? Thank You.

I don't know, best open a new thread.

 

[Mashiane]

Thanks for this, will help enhance my BANano implementation of this. Im sure I will learn some new tricks.

 

[ilan]

hi, where can i download the library FirebaseAuthREST? would like to test it.
thanx

 

[Alexander Stolte]

hi, where can i download the library FirebaseAuthREST? would like to test it.

 

[Alexander Stolte]

i think you mean this:

[B4X] Firebase Auth REST Helper - manage the access tokens

The advantage of the rest API of Firebase auth is that it can be used cross platform. The downside is, we have to take care of the user access tokens ourselves. That's why I wrote this class, it works with the "FirebaseAuthREST" class. The class was inspired by @Erel oauth2 class, adapted to my...

www.b4x.com

 

[ilan]

i think you mean this:

[B4X] Firebase Auth REST Helper - manage the access tokens

The advantage of the rest API of Firebase auth is that it can be used cross platform. The downside is, we have to take care of the user access tokens ourselves. That's why I wrote this class, it works with the "FirebaseAuthREST" class. The class was inspired by @Erel oauth2 class, adapted to my...

www.b4x.com

ohh, ok so there is no lib i need to add the class to the project
thankx!

 

[ilan]

i am playing around with your class and it looks amazing. i tried to register a new account and login with it and works great. Thanks a lot for your class!!! ?

 

[invocker]

Thanks a lot for your class How about register with photo profile and upload storage

 

[yiankos1]

Hello @Alexander Stolte,

Are there any security issues of this exposed API key in app?

Thank you.

 

[Alexander Stolte]

Are there any security issues of this exposed API key in app?

No key in your app is safe. That's why Firebase has security roles, so that only logged in users can do anything and then only what they are authorized to do.

 

[yiankos1]

No key in your app is safe. That's why Firebase has security roles, so that only logged in users can do anything and then only what they are authorized to do.

Thank you for your answer.

With this method confirmEmailVerification you get as a response, beneath the others, emailVerified property as boolean. I want to check if email is verified before a user login, but i can't find a way to get oobCode. oobCode sent as a hyperlink in email in order to click and confirm.

 

[Alexander Stolte]

It's better to make a new thread for this. I haven't done anything with Firebase in 3 years.

 

[Alexander Stolte]

Update

• 1.02
  • Add getUserData - Thanks to @Blueforcer

Firebase Auth - emailVerified

Good Morning, im using the B4J Library [B4X] Firebase Auth REST API from @Alexander Stolte. Ive implemented it into my jServer backend for my App login process. When the user registers, I start signUpEmailPW and if that works, then immediately sendEmailVerification. The email also arrives...

www.b4x.com