# Auth API

In addition to the [Mitto API](/api/mitto), Mitto users also have
access to the Auth API, which among other things, enables the ability to list,
create, update, and delete users in the Mitto UI.

## Endpoints and Methods

Mitto has [Swagger](https://swagger.io/) documentation at
`https://{mitto_url}/auth/docs`. You can see all the Auth API endpoints and
test them using the Swagger UI.

.. image:: assets/auth__swagger.png
   :alt: Mitto Auth API Swagger docs

## Auth API Usage

For more information about API usage and authorization please visit the [Mitto
API help page.](/api/mitto/)

### Steps to Create A Mitto User

1. Browse to `https://{mitto_url}/auth/docs#/default/create_user_users_post`
2. Expand POST `/api/users` Create User endpoint
3. Edit the input parameters so that the strings represent the appropriate user data
4. `Execute` the Create User command
5. *Optional* but usually necessary, create the user inside of Mitto's
   PostgreSQL database (see link below). A simple command to create a
   PostGreSQL Super User: `CREATE USER "newuser" WITH PASSWORD 'password'
   SUPERUSER CREATEDB;`

.. NOTE::

   A database user is not created. Please consult 
   `PostgreSQL Documentation <https://www.postgresql.org/docs/10/sql-createuser.html>`__ 
   on creating new users.


### Steps to Delete a Mitto User

1. Browse to `https://{mitto_url}/auth/docs#/default/create_user_users_post`
2. Expand and Execute GET `/api/users` endpoint to list the users
3. Retrieve the ID for the user you wish to delete
4. Scroll down to the DELETE `/api/users/{user_id}` endpoint
5. Enter the ID for the desired user into the user_id field
6. `Execute` the DELETE `/api/users/{user_id}`
7. *Optional but usually necessary, remove the user from Mitto's PostgreSQL*

### Steps to List existing Mitto Users

1. Browse to `https://{mitto_url}/auth/docs#/default/list_users_users_get`
2. `Execute` the List Users command
3. The output will contain information for all existing users.