42 lines
1.8 KiB
Plaintext
42 lines
1.8 KiB
Plaintext
|
# Login (object)
|
||
|
|
User related entity for creating a token using application credentials
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ username: `hardiready` (string, required) - username of the app-user
|
||
|
|
+ password: `password` (string, required) - password of the app-user
|
||
|
|
|
||
|
|
# LoginResponse (object)
|
||
|
|
Response object on successful token creation
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ _id: `593d632772d35225232bcabb` (string, required) - the unique id of the app-user
|
||
|
|
+ username: `hardiready` (string, required) - the username of the app-user
|
||
|
|
+ permission: 1 - the permission level of the app-user (0 - user, 1 - sql, 2 - hl, 3 - maintainer, 4 - admin)
|
||
|
|
+ squad (Squad, required) - squad the app-user is member of
|
||
|
|
+ token: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1OTNkNWUzZjcyZDM1MjI1MjIyYmNhYmEiLCJpYXQiOjE1MjEzOTQ5NDYsImV4cCI6MTUyMzgxNDE0Nn0.vOAwA5--qrx8BglhyGZWVYx7LeuRKOHH0NQXmHFNhIQ` (string,required) - generated token
|
||
|
|
+ tokenExpireDate: `2018-04-15T17:42:25.050Z` (string,required) - expiration date of the token
|
||
|
|
|
||
|
|
|
||
|
|
# Registration (object)
|
||
|
|
User related entity for reflecting membership to another resource (groups, material databases)
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ email: `darth.vader@starwars.com` (string, required) - email of the user
|
||
|
|
+ password: `password` (string, required) - password of the user
|
||
|
|
+ first_name: `Anakin` (string, required) - first name of the user
|
||
|
|
+ last_name: `Skywalker` (string, required) - last name of the user
|
||
|
|
+ role: `Fleet Commander` (string) - role of the user in his organization
|
||
|
|
+ organization: `Imperium` (string) - organization the user is member of
|
||
|
|
|
||
|
|
|
||
|
|
# RegistrationResponse (object)
|
||
|
|
Response object on successful user registration
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ email: `darth.vader@starwars.com` (string) - email the new user has been created with
|
||
|
|
+ uuid: `123e4567-e89b-12d3-a456-426655440000` (string) - a unique key to the user which is to be used across 3rd party applications
|