API Reference V1 - SayidHosseini/authentiq GitHub Wiki

This is used to check if the service is up.

This is used to register a new user.

{
    "email": "EMAIL ADDRESS",
    "password": "PASSWORD"
}

This is used to login. It returns a JWT token which is used when authentication is required.

{
    "email": "EMAIL ADDRESS",
    "password": "PASSWORD"
}

{
    "token": "GENERATED TOKEN"
}

This is to check if the user is logged in and his/her session is not expired. The token that needs to be validated is sent in Authorization header as Bearer Token.

This is used to change user password. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token.

{
    "password": "CURRENT PASSWORD",
    "newPassword": "NEW PASSWORD"
}

This is used to get a dynamic list of users' id, email and role. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token. Only admin role users can do this.

This is used to get the current role of the user. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token. All roles can do this.

{
    "id": "GENERATED_USER_ID",
    "email": "EMAIL ADDRESS",
    "role": "admin" | "user" | "guest"
}

This is used to change the current role of a user. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token. Only admin role users can do this.

{
    "email": "EMAIL ADDRESS",
    "role": "admin" | "user" | "guest"
}

This is used to logout, which makes the user's token invalid after request success. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token.

This is used to delete a user completely from the service, which makes the user's credentials invalid after request success. The user needs to login first to make this request. The acquired token must be provided in Authorization header as Bearer Token.

{
    "password": "PASSWORD",
}