User Authentication

Login Route

POST - /login/

Description

Description

A rota de login é fundamental para autenticar o usuário no sistema, garantindo que ele tenha acesso apenas aos módulos que a instituição associada está autorizada a utilizar e visualizar no frontend. Durante o processo de login, dois tokens JWT são gerados e retornados na resposta:

user_access: Este token concede ao usuário a permissão para acessar o sistema, encapsulando informações essenciais, como ID do usuário, nome, status, e o grupo ao qual ele pertence.

• obs: email_auth: Informar se está configurado as credenciais de email para envio de email

system_modules: Este token define quais módulos do sistema estão disponíveis para o usuário, com base nas permissões concedidas à instituição.

User Access

{
"pk_user": 1,
"registration": "00001",
"username": "Patrick Berlatto Piccini",
"status": true,
"campus_code": 1,
"pk_campus": 1,
"email_auth": true,
"ip_adress": "131.221.12.242",
"group": "superuser",
"current_school_year": 3,
"current_term": 2,
"exp": 2081726873
}

System Modules

{
"absence": 1,
"grade": 1,
"graphic": 1,
"home": 1,
"register": 1,
"campus_name": "Atiitus Educação Passo Fundo",
"cnpj": "02353336035",
"free_trial": "2024-01-29",
"in_test": false
}

Name	In	Type	Default	Nullable	Description
Authorization	header	string	None	No	Obtained in Login

Request Body

application/json

{
    "registration": "00001",
    "password": "admin"
}

Body Schema

{
    "registration": string,
    "password": string
}

Response Body

200

application/json

    {
        "user_access": "R5cCI6IkpXVCJ9.eyJwa191c2VyIjoxLCJyZWdpc3RyYXRpb24iOiIwMDAwM...",
        "system_modules": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhYn..."
    }

Schema

    {
        "registration": string,
        "password": string
    }

400

Error 1Error 2Error 3Error 5Error 6

    {
        "detail": "Informe o numero de matricula para o login.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": "Informe a senha para o login.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": "Este usuario não existe!",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": "Não fio possivel encontrar um periodo no school_year_date com a data atual.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": "Este usuario não contem grupos!",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

401

Error 1

    {
        "datail": "Credenciais incorretas!"
    }

Schema

    {
        "datail": string
    }

403

Error 1

    {
        "datail": "Usuario Bloqueado!"
    }

Schema

    {
        "datail": string
    }

500

Error 1Error 2Error 3Error 4

    {
        "detail": "Problemas do servidor ao atualizar acesso do usuario.",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string,
        "error": string
    }

    {
        "detail": "Problemas do servidor buscar grupos do usuario.",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string,
        "error": string
    }

    {
        "detail": "Problemas do servidor buscar school_year_date",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string,
        "error": string
    }

    {
        "detail": "Problemas do servidor ao autenticar usuario.",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string,
        "error": string
    }