Summary

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

Details

Page properties

Content

...	...	@@ -2,38 +2,16 @@
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 algorithms
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 errors 401 and 403 for the authentication failure.
19		-
20	20	= Endpoints =
21	21
22	22	|(% style="width:162px" %)**URL [method]**|(% style="width:284px" %)**Description**|(% style="width:580px" %)**Input example**|(% style="width:472px" %)**Output example**
23	23	|(% style="width:162px" %)/auth [POST]|(% style="width:284px" %)generate a token to get access to all other endpoints.|(% style="width:580px" %)(((
24		-The input data must be placed in the **//__JSON body__ //**of the request as the following example :
	9	+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		-{{code language="json"}}
27		-{
28		- "user" : "user1",
29		- "password" : "abcd.12345",
30		- "env" : "iXPath"
31		-}
32		-{{/code}}
	11	+* __login__: user4r
	12	+* __password__: abcdef
33	33
34		-__NB__ : "user" and "password" are **mandatory**.
35		-
36		-meanwhile, "env" param could be generated automatically if it is not mentioned or no more active.
	14	+[[image:2021-11-17_16h10_57.png]]
37	37	)))|(% style="width:472px" %){{code language="JSON" layout="LINENUMBERS"}}{
38	38	"timestamp": 1637162043978,
39	39	"status": "200",
...	...	@@ -54,7 +54,7 @@
54	54	{{code language="JSON" layout="LINENUMBERS"}}
55	55	{
56	56	"timestamp": 1637164878357,
57		- "status": "401",
	35	+ "status": "500",
58	58	"error": "the user's information not found : user, password",
59	59	"thechnicalError": "the user's information not found : user, password"
60	60	}