Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,26 +1,11 @@
1		-= Introduction =
	1	+= Introduction =
2	2
3	3	This documentation describes how to get authenticated to the iXPath App.
4	4
5		-
6		-= Validation =
7		-
8		-The endpoint should verify those points :
9		-
10		-- Encrypt the password with SHA256 algorithme
11		-
12		-- Verify if the user's environment is active
13		-
14		-- Remove all unnecessary verifications (Env's verification)
15		-
16		-- Verify if the user is activated.
17		-
18		-- Throw error 401 and 403 for the authentication faillure.
19		-
20	20	= Endpoints =
21	21
22		-|(% style="width:162px" %)**URL [method]**|(% style="width:284px" %)**Description**|(% style="width:580px" %)**Input example**|(% style="width:472px" %)**Output example**
23		-|(% style="width:162px" %)/auth [POST]|(% style="width:284px" %)generate a token to get access to all other endpoints.|(% style="width:580px" %)(((
	7	+|(% style="width:230px" %)**URL [method]**|(% style="width:379px" %)**Description**|(% style="width:279px" %)**Input example**|(% style="width:472px" %)**Output example**
	8	+|(% style="width:230px" %)/auth [POST]|(% style="width:379px" %)generate a token to get access to all other endpoints.|(% style="width:279px" %)(((
24	24	The input data are "login" and "password", and they must be placed in the **//__header__ //**of the request as the following example :
25	25
26	26	* __login__: user4r
...	...	@@ -40,6 +40,7 @@
40	40	}
41	41	}{{/code}}
42	42
	28	+
43	43	= Possible errors or exceptions =
44	44
45	45	* If information is not filled in correctly or the user doesn't exist, the response will look like this example :
...	...	@@ -47,7 +47,7 @@
47	47	{{code language="JSON" layout="LINENUMBERS"}}
48	48	{
49	49	"timestamp": 1637164878357,
50		- "status": "401",
	36	+ "status": "500",
51	51	"error": "the user's information not found : user, password",
52	52	"thechnicalError": "the user's information not found : user, password"
53	53	}