Update authentication documentation

docs/developer/auth.rst

@@ -11,82 +11,179 @@ All the authentication, token generation and configuration process is handled
 through the REST endpoints that are made available by default on
 kytos installation:
 
-This endpoint creates new users:
+Creating superusers
+===================
 
-.. code-block:: shell
+To access the REST Endpoints related to Authentication, it is necessary to 
+register a first user (Superuser). To do this, run kytos with the -f and -C 
+arguments:
 
-    POST http://127.0.0.1:8181/api/kytos/core/auth/users/
+.. code-block:: console 
 
-    $ curl -X POST \
-        -H 'Content-Type: application/json' \
-        -d '{"username":"kytos",
-        "password":"your_password",
-        "email": "babel42@email.com"}' \
-        URL
+   $ kytosd -f -C
+
+   -----------------------
+    username: <your_name>
+    email: <your_email>
+    password: <your_pass>
+    re-password: <your_pass>
+
+
+
+Login
+=====
 
 This endpoint verifies a user and returns a valid token if authentication
 is correct:
 
-.. code-block:: shell
+Endpoint:
+
+.. code-block:: console
+
+    GET /api/kytos/core/auth/login/
+
+Request:
 
-    GET http://127.0.0.1:8181/api/kytos/core/auth/login/
+.. code-block :: console
 
-    $ curl -X GET \
-        -H 'Accept:application/json' \
-        -H 'Authorization:Basic username:password' \
-        URL
+    $ curl -u username:password http://127.0.0.1:8181/api/kytos/core/auth/login/
+
+Response:
+
+.. code-block:: console
+
+    {"token": token_here}
+
+List Users
+==========
 
 This endpoint lists the registered users:
 
-.. code-block:: shell
+Endpoint:
+
+.. code-block:: console
+
+    GET /api/kytos/core/auth/users/
 
-    GET http://127.0.0.1:8181/api/kytos/core/auth/v1/users/
+Request:
 
-    $ curl -X GET \
-        -H 'Accept:application/json' \
-        -H 'Authorization: Bearer ${TOKEN}' \
-        URL
+.. code-block :: console
+
+    $ curl -i http://127.0.0.1:8181/api/kytos/core/auth/users \
+        -H "Authorization: Bearer token"
+
+Response:
+
+.. code-block:: console
+
+   {"users":[id]}
+
+Get user details
+================
 
 This endpoint gets details about a specific user:
 
-.. code-block:: shell
+Endpoint:
+
+.. code-block:: console
+
+    GET /api/kytos/core/auth/users/<user_id>/
+
+Request:
+
+.. code-block :: console
+
+    $ curl -i http://127.0.0.1:8181/api/kytos/core/auth/users/<user_id> \
+        -H "Authorization: Bearer token"
+
+Response:
+
+.. code-block:: console
+
+   {"data": {"email": "babel42@email.com", "username": "user_id"}}
 
-    GET http://127.0.0.1:8181/api/kytos/core/auth/users/<user_id>/
+Create extra users
+==================
 
-    $ curl -X GET \
-        -H 'Content-type: application/json' \
-        -H 'Accept: application/json' \
-        -H 'Authorization: Bearer ${TOKEN}' \
-        -d '{"user_id": "001"}' \
-        URL
+This endpoint allows you to create new users:
 
+This endpoint requires a token.
+
+Endpoint:
+
+.. code-block:: console
+
+    POST /api/kytos/core/auth/users/
+
+Request:
+
+.. code-block:: console
+
+    $ curl -d '{"username": "<your_name>", "password": "<pass>", \ 
+        "email": "<your_email>"}' \
+        -H "Content-Type: application/json" \
+        -H "Authorization: Bearer token" \
+        http://127.0.0.1:8181/api/kytos/core/auth/users/
+
+
+Response:
+
+.. code-block:: console
+
+    User successfully created
+
+Delete a user
+=============
 
 This endpoint deletes a specific user.
 
-.. code-block:: shell
+Endpoint:
+
+.. code-block:: console
 
-    DELETE http://127.0.0.1:8181/api/kytos/core/auth/v1/users/<user_id>/
+    DELETE /api/kytos/core/auth/users/<user_id>/
+
+Request:
+
+.. code-block :: console
 
     $ curl -X DELETE \
-        -H 'Content-type: application/json' \
-        -H 'Accept: application/json' \
-        -H 'Authorization: Bearer ${TOKEN}' \
-        -d '{"user_id": "001"}' \
-        URL
+        -H 'Authorization: Bearer token' \
+        http://127.0.0.1:8181/api/kytos/core/auth/users/<user_id>
+
+
+Response:
+
+.. code-block :: console
+
+  User successfully deleted
+
+Update a user
+=============
 
 This endpoint update a specific user:
 
-.. code-block:: shell
+Endpoint:
+
+.. code-block:: console
+
+    PATCH /api/kytos/core/auth/users/<user_id>/
 
-    PATCH http://127.0.0.1:8181/api/kytos/core/auth/v1/users/<user_id>/
+Request:
+
+.. code-block :: console
 
     $ curl -X PATCH \
         -H 'Content-Type: application/json' \
-        -H 'Authorization: Bearer ${TOKEN}' \
-        -d '{"user_id": "001"}' \
-        URL
+        -H 'Authorization: Bearer token' \
+        -d '{"email": "babel43@email.com"}' \
+        http://127.0.0.1:8181/api/kytos/core/auth/users/<user_id>
+
+Response:
+
+.. code-block :: console
 
+    User successfully updated
 
 The process to protect an endpoint is found in session `How to protect a NApp
-REST endpoint <https://docs.kytos.io/developer/creating_a_napp/>`_
-.
+REST endpoint <https://docs.kytos.io/developer/creating_a_napp/>`_.