Education portal

User Auth

• Registration

  • User registration

• Login

  • Sign-in

• Logout

• About user

• Password reset

  • Reset password
  • Reset confirmation

• Change password

User auth

Registration

api/auth/registration/

Params:

{
  "actions": {
    "POST": {
      "username": {
        "type": "string",
        "required": true,
        "min_length": 1,
        "max_length": 150
      },
      "email": {
        "type": "email",
        "required": false
      },
      "password1": {
        "type": "string",
        "required": true
      },
      "password2": {
        "type": "string",
        "required": true
      }
    }
  }
}

Response

key: string

Login

api/auth/login/

{
  "actions": {
    "POST": {
      "username": {
        "type": "string",
        "required": false
      },
      "email": {
        "type": "email",
        "required": false
      },
      "password": {
        "type": "string",
        "required": true
      }
    }
  }
}

Response

key: string

Logout

Method POST

api/auth/logout/

About user

METHODS: GET, PUT

api/auth/user/

FOR GET:

RESPONSE:

{
    "pk": "int",
    "username": "string",
    "email": "email",
    "first_name": "string",
    "last_name": "string"
}

FOR PUT:

{
  "actions" : {
        "PUT": {
            "username": {
                "type": "string",
                "required": true,
                "max_length": 150
            },
            "first_name": {
                "type": "string",
                "required": false,
                "max_length": 150
            },
            "last_name": {
                "type": "string",
                "required": false,
                "max_length": 150
            }
        }
  }
}

Password reset

api/auth/password/reset/

{
  "actions": {
        "POST": {
            "email": {
                "type": "email",
                "required": true
            }
        }
    }
}

Password reset confirmation

api/auth/ password/reset/confirm/

{
  "actions": {
    "POST": {
      "new_password1": {
        "type": "string",
        "required": true,
        "max_length": 128
      },
      "new_password2": {
        "type": "string",
        "required": true,
        "max_length": 128
      },
      "uid": {
        "type": "string",
        "required": true
      },
      "token": {
        "type": "string",
        "required": true
      }
    }
  }
}

Change password

api/auth/password/change/

{
  "actions": {
        "POST": {
            "new_password1": {
                "type": "string",
                "required": true,
                "max_length": 128
            },
            "new_password2": {
                "type": "string",
                "required": true,
                "max_length": 128
            }
        }
    }
}