Authentication API's

Basic Authentication

Register a User

1. POST - http://localhost:3000/auth

   Request Header should specify ContentType: Application/json

   Body of the POST request should contain:

   {
       "email" : "[email protected]",
       "password" : "password-here",
       "password_confirmation" : "password-here",
       "optional_parameter" : "value",
       "config_name":"default",
       "confirm_success_url":"http:localhost:3000"
   }
   

   Optional parameters in the sign_up form can be configured using reference - https://github.com/plataformatec/devise#strong-parameters

2. POST - http://localhost:3000/auth/sign_in - If email is not confirmed

   Request Header should specify ContentType: Application/json

   Body of the POST request should contain:

    {
        "email" : "[email protected]",
        "password" : "password-here",
    }
   

   Response:

    {
        "success": false,
        "errors": : ["A confirmation email was sent to your account at [email protected]. You must follow the instructions in the email before your account can be activated"]
    }
   

3. POST - http://localhost:3000/auth/sign_in - After email confirmed

   Request Header should specify ContentType: Application/json

   Body of the POST request should contain:

    {
        "email" : "[email protected]",
        "password" : "password-here",
    }
   

   Response: The whole user object is returned.

    {
        "data": {
            "id": 1,
            "provider": "email",
            "uid": "[email protected]",
            "name": null,
            "nickname": null,
            "image": null,
            "email": "[email protected]",
            "address": null
        }
    }
   

Note: Below mentioned files are important for looking at the code base of the devise_token_auth gem

• registrations_controller.rb - Create, Update and Delete User accounts
  • Link - https://github.com/lynndylanhurley/devise_token_auth/blob/7a8f08a1c9fb97a42750ba3c1cb4f4ff5b14862e/app/controllers/devise_token_auth/registrations_controller.rb
• sessions_controller.rb - SignUp, SignIn and SignOut
  • Link - https://github.com/lynndylanhurley/devise_token_auth/blob/2a3cb88c9b893a756aebd80d18d29d84a6f94ecb/app/controllers/devise_token_auth/sessions_controller.rb
• set_user_by_token.rb - Set up a user by using uid, client and access-token
  • Link - https://github.com/lynndylanhurley/devise_token_auth/blob/e0b4dff6bc76ad7f3021e579cfa23477752140ff/app/controllers/devise_token_auth/concerns/set_user_by_token.rb
• token_validations_controller.rb - Validates a Token
  • Link - https://github.com/lynndylanhurley/devise_token_auth/blob/2a3cb88c9b893a756aebd80d18d29d84a6f94ecb/app/controllers/devise_token_auth/token_validations_controller.rb