Authentication

Here you will find everything about authentication

Authenticate a new user

POST http://localhost:3001/auth/signup

Request Body

Name

Type

Description

email*

string

user's email

username*

string

user's username

maxLength: 30

profile*

object

user's profile

profile.name*

string

user's name

maxLength: 60

password*

string

user's password

minLength: 6

profile.socialMediaURLs*

object

object with supported social media URLs

profile.socialMediaURLs.gitHub

string

user's GitHub URL

profile.socialMediaURLs.linkedIn

string

user's LinkedIn URL

profile.socialMediaURLs.instagram

string

user's Instagram URL

profile.socialMediaURLs.twitter

string

user's Twitter URL

profile.socialMediaURLs.facebook

string

user's Facebook URL

Request

curl --location --request POST 'http://localhost:3001/auth/signUp' \
--data-raw '{
    "email": "[email protected]",
    "password": "123456",
    "username": "example",
    "profile": {
        "name": "Example",
        "socialMediaURLs": {}S
    }
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "[email protected]",
  "password": "123456",
  "username": "example",
  "profile": {
    "name": "Example",
    "socialMediaURLs": {}
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signUp", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "[email protected]",
  "password": "123456",
  "username": "example",
  "profile": {
    "name": "Example",
    "socialMediaURLs": {}
  }
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signUp',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
}

Response

JSON

{
    "id": "63cd0f17b570328000845e2d",
    "createdAt": "2023-01-22T10:25:27.336Z",
    "updatedAt": "2023-01-22T10:25:27.336Z",
    "username": "example",
    "email": "[email protected]",
    "roles": [
        "USER"
    ],
    "profile": {
        "name": "Example",
        "emailVerified": null,
        "photo": null,
        "socialMediaURLs": {
            "gitHub": null,
            "linkedIn": null,
            "instagram": null,
            "twitter": null,
            "facebook": null
        }
    },
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjoiNjNjZDBmMTdiNTcwMzI4MDAwODQ1ZTJkIiwiY3JlYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXBkYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXNlcm5hbWUiOiJleGFtcGxlIiwiZW1haWwiOiJleGFtcGxlQGdlbmZpZC5kZXYiLCJyb2xlcyI6WyJVU0VSIl0sInByb2ZpbGUiOnsibmFtZSI6IkV4YW1wbGUiLCJlbWFpbFZlcmlmaWVkIjpudWxsLCJwaG90byI6bnVsbCwic29jaWFsTWVkaWFVUkxzIjp7ImdpdEh1YiI6bnVsbCwibGlua2VkSW4iOm51bGwsImluc3RhZ3JhbSI6bnVsbCwidHdpdHRlciI6bnVsbCwiZmFjZWJvb2siOm51bGx9fX0sImlhdCI6MTY3NDM4MzEyNywiZXhwIjoxNjc0OTg3OTI3fQ.-SFuCh_CuWGVQBESXd1UrtP6AE1PSFn-owLiLAsspUk"
}

Request

curl --location --request POST 'http://localhost:3001/auth/signUp' \
--data-raw '{
    "email": "examplegenfid.dev",
    "password": "1234",
    "username": "example",
    "profile": {
        "name": null,
        "socialMediaURLs": ""
    }
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "examplegenfid.dev",
  "password": "1234",
  "username": "example",
  "profile": {
    "name": null,
    "socialMediaURLs": ""
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signUp", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "examplegenfid.dev",
  "password": "1234",
  "username": "example",
  "profile": {
    "name": null,
    "socialMediaURLs": ""
  }
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signUp',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "status": 400,
    "message": "Bad request, see \"reasons\" for more information",
    "reasons": [
        "profile.name must be shorter than or equal to 60 characters",
        "profile.name should not be empty",
        "profile.name must be a string",
        "profile.socialMediaURLs must be an object",
        "profile.nested property socialMediaURLs must be either object or array"
    ],
    "timestamp": "2023-01-22T10:28:55.841Z",
    "path": "/auth/signUp"
}

Request

curl --location --request POST 'http://localhost:3001/auth/signUp' \
--data-raw '{
    "email": "[email protected]",
    "password": "123456",
    "username": "example",
    "profile": {
        "name": "Example",
        "socialMediaURLs": {}
    }
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "[email protected]",
  "password": "123456",
  "username": "example",
  "profile": {
    "name": "Example",
    "socialMediaURLs": {}
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signUp", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "[email protected]",
  "password": "123456",
  "username": "example",
  "profile": {
    "name": "Example",
    "socialMediaURLs": {}
  }
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signUp',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
}

Response

JSON

{
    "status": 409,
    "message": "Email already registred",
    "timestamp": "2023-01-22T10:44:57.586Z",
    "path": "/auth/signUp"
}

Authenticate a registred user

POST http://localhost:3001/auth/signin

Request Body

Name

Type

Description

email*

string

user's email

password*

string

user's password

Request

curl --location --request POST 'http://localhost:3001/auth/signIn' \
--data-raw '{
    "email": "[email protected]",
    "password": "123456"
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "[email protected]",
  "password": "123456"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signIn", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "[email protected]",
  "password": "123456"
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signIn',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "id": "63cd0f17b570328000845e2d",
    "createdAt": "2023-01-22T10:25:27.336Z",
    "updatedAt": "2023-01-22T10:25:27.336Z",
    "username": "example",
    "email": "[email protected]",
    "roles": [
        "USER"
    ],
    "profile": {
        "name": "Example",
        "emailVerified": null,
        "photo": null,
        "socialMediaURLs": {
            "gitHub": null,
            "linkedIn": null,
            "instagram": null,
            "twitter": null,
            "facebook": null
        }
    },
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjoiNjNjZDBmMTdiNTcwMzI4MDAwODQ1ZTJkIiwiY3JlYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXBkYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXNlcm5hbWUiOiJleGFtcGxlIiwiZW1haWwiOiJleGFtcGxlQGdlbmZpZC5kZXYiLCJyb2xlcyI6WyJVU0VSIl0sInByb2ZpbGUiOnsibmFtZSI6IkV4YW1wbGUiLCJlbWFpbFZlcmlmaWVkIjpudWxsLCJwaG90byI6bnVsbCwic29jaWFsTWVkaWFVUkxzIjp7ImdpdEh1YiI6bnVsbCwibGlua2VkSW4iOm51bGwsImluc3RhZ3JhbSI6bnVsbCwidHdpdHRlciI6bnVsbCwiZmFjZWJvb2siOm51bGx9fX0sImlhdCI6MTY3NDM4NDg2MSwiZXhwIjoxNjc0OTg5NjYxfQ.JlkmoUK0uClYBolh3ZctoTHgo24vFu7aSaNggOF2FJw"
}

Request

curl --location --request POST 'http://localhost:3001/auth/signIn' \
--data-raw '{
    "email": "[email protected]",
    "password": "12346"
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "[email protected]",
  "password": "12346"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signIn", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "[email protected]",
  "password": "12346"
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signIn',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "status": 404,
    "message": "No User found",
    "timestamp": "2023-01-22T10:57:21.440Z",
    "path": "/auth/signIn"
}

Request

curl --location --request POST 'http://localhost:3001/auth/signIn' \
--data-raw '{
    "email": "examplegenfid.dev",
    "password": null
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "email": "examplegenfid.dev",
  "password": null
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/signIn", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');
let data = JSON.stringify({
  "email": "examplegenfid.dev",
  "password": null
});

let config = {
  method: 'post',
  url: 'http://localhost:3001/auth/signIn',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "status": 400,
    "message": "Bad request, see \"reasons\" for more information",
    "reasons": [
        "email must be an email",
        "password should not be empty",
        "password must be a string"
    ],
    "timestamp": "2023-01-22T11:00:53.443Z",
    "path": "/auth/signIn"
}

Get signed user

GET http://localhost:3001/auth/profile

Headers

Name

Type

Description

Authorization

string

Bearer <access_token>

Cookies

Name

Type

Description

acceess_token

string

user's access token

(automatically sent by api)

Request

curl --location --request GET 'http://localhost:3001/auth/profile'

var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/profile", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));const axios = require('axios');

let config = {
  method: 'get',
  url: 'http://localhost:3001/auth/profile',
  headers: { }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

const axios = require('axios');

let config = {
  method: 'get',
  url: 'http://localhost:3001/auth/profile',
  headers: {}
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "id": "63cd0f17b570328000845e2d",
    "createdAt": "2023-01-22T10:25:27.336Z",
    "updatedAt": "2023-01-22T10:25:27.336Z",
    "username": "example",
    "email": "[email protected]",
    "roles": [
        "USER"
    ],
    "profile": {
        "name": "Example",
        "emailVerified": null,
        "photo": null,
        "socialMediaURLs": {
            "gitHub": null,
            "linkedIn": null,
            "instagram": null,
            "twitter": null,
            "facebook": null
        }
    },
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjoiNjNjZDBmMTdiNTcwMzI4MDAwODQ1ZTJkIiwiY3JlYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXBkYXRlZEF0IjoiMjAyMy0wMS0yMlQxMDoyNToyNy4zMzZaIiwidXNlcm5hbWUiOiJleGFtcGxlIiwiZW1haWwiOiJleGFtcGxlQGdlbmZpZC5kZXYiLCJyb2xlcyI6WyJVU0VSIl0sInByb2ZpbGUiOnsibmFtZSI6IkV4YW1wbGUiLCJlbWFpbFZlcmlmaWVkIjpudWxsLCJwaG90byI6bnVsbCwic29jaWFsTWVkaWFVUkxzIjp7ImdpdEh1YiI6bnVsbCwibGlua2VkSW4iOm51bGwsImluc3RhZ3JhbSI6bnVsbCwidHdpdHRlciI6bnVsbCwiZmFjZWJvb2siOm51bGx9fX0sImlhdCI6MTY3NDM4NTAzOCwiZXhwIjoxNjc0OTg5ODM4fQ.zWPSIOJPfmSggx1DjTHKxM40vRMXVerIS_VXKhMgq44"
}

Request

curl --location --request GET 'http://localhost:3001/auth/profile'

var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("http://localhost:3001/auth/profile", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

const axios = require('axios');

let config = {
  method: 'get',
  url: 'http://localhost:3001/auth/profile',
  headers: { }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

JSON

{
    "status": 401,
    "message": "Missing access token",
    "timestamp": "2023-01-22T11:21:08.213Z",
    "path": "/auth/profile"
}

PreviousAPI Reference NextUsers

Last updated 2 years ago

Was this helpful?