torrust_index_backend::web::api::v1

Module auth

Source
Expand description

API authentication.

The API uses a bearer token authentication scheme.

API clients must have an account on the website to be able to use the API.

§Authentication flow

§Registration

curl \
  --header "Content-Type: application/json" \
  --request POST \
  --data '{"username":"indexadmin","email":"indexadmin@torrust.com","password":"BenoitMandelbrot1924","confirm_password":"BenoitMandelbrot1924"}' \
  http://127.0.0.1:3001/v1/user/register

NOTICE: The first user is automatically an administrator. Currently, there is no way to change this. There is one administrator per instance. And you cannot delete the administrator account or make another user an administrator. For testing purposes, you can create a new administrator account by creating a new user and then manually changing the administrator field in the torrust_users table to 1.

§Login

curl \
  --header "Content-Type: application/json" \
  --request POST \
  --data '{"login":"indexadmin","password":"BenoitMandelbrot1924"}' \
  http://127.0.0.1:3001/v1/user/login

Response

{
    "data":{
      "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjp7InVzZXJfaWQiOjEsInVzZXJuYW1lIjoiaW5kZXhhZG1pbiIsImFkbWluaXN0cmF0b3IiOnRydWV9LCJleHAiOjE2ODYyMTU3ODh9.4k8ty27DiWwOk4WVcYEhIrAndhpXMRWnLZ3i_HlJnvI",
      "username":"indexadmin",
      "admin":true
    }
  }

NOTICE: The token is valid for 2 weeks (1_209_600 seconds). After that, you will have to renew the token.

NOTICE: The token is associated with the user role. If you change the user’s role, you will have to log in again to get a new token with the new role.

§Using the token

Some endpoints require authentication. To use the token, you must add the Authorization header to your request. For example, if you want to add a new category, you must do the following:

curl \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjp7InVzZXJfaWQiOjEsInVzZXJuYW1lIjoiaW5kZXhhZG1pbiIsImFkbWluaXN0cmF0b3IiOnRydWV9LCJleHAiOjE2ODYyMTU3ODh9.4k8ty27DiWwOk4WVcYEhIrAndhpXMRWnLZ3i_HlJnvI" \
  --request POST \
  --data '{"name":"new category","icon":null}' \
  http://127.0.0.1:3001/v1/category

Response

{
  "data": "new category"
}

Structs§

Authentication

Functions§

get_optional_logged_in_user
If the user is logged in, returns the user’s ID. Otherwise, returns None.
parse_token
Parses the token from the Authorization header.