Login
Used to collect a Token for a registered User.
URL : /api/v1/auth/login
Method : POST
Auth required : NO
Data constraints
{
"username": "[valid email address or username]",
"password": "[password in plain text]"
}
1
2
3
4
2
3
4
Data example
{
"username": "administrator",
"password": "abcd1234"
}
1
2
3
4
2
3
4
Success Response
Code : 200 OK
Content example
{
"id": 1,
"username": "administrator",
"email": "alali@domain.com",
"token": "Mq9WH5pgvLOpdwZi5BXCpkms_n5-M742",
"roles": [
"_administrator_"
],
"permissions": [
"form-archive-file:edit",
"form-archive-file:view",
"form-core-samples:edit",
"form-core-samples:view",
"form-cores:edit",
"form-cores:view",
"form-hole:edit",
"form-hole:view",
"form-init-gas:edit",
"form-init-gas:view",
"form-init-temp:edit",
"form-init-temp:view",
"form-project-site-1:edit",
"form-project-site-1:view",
"form-section:edit",
"form-section:view"
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Error Response
Condition : If 'username' and 'password' combination is wrong.
Code : 422 Unprocessable entity
Content :
[
{
"field": "password",
"message": "Login data is invalid"
}
]
1
2
3
4
5
6
2
3
4
5
6