By Pedro Ruiz Hidalgo
Manage your own authorization system with this API. The organization is based on the owner concepts to which the applications that have subscribed users belong. In other words, you must start creating an owner, then create an application and then its users. Each user is identified by email as a unique key in the owners table. Then, each application is created by a single owner. Everything Auth-mysql v 2.0.2 is built under the concept of cascade, which means that if you delete an owner, all applications and users will also be deleted. Consequently, in case of elimination of the application, all its users will disappear. Only the removal of a single user has no other effect than this removal process. All passwords have secure cryptographic storage. Both owners and applications will be identified by uuid provided by the application.
All routes must be accessed following the specification of this table
| header | value |
|---|---|
| Content-Type | application/json |
Path ~/appowner/create POST method.
Request data sample
{
"firstname": "Jason",
"lastname": "Bourne",
"email": "[email protected]",
"password": "theverymuchsecretpasswordofjasonbourne"
}It produces a response like
{
"firstname": "Jason",
"lastname": "Bourne",
"email": "[email protected]",
"deletion_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Impib3VybmVAZ21haWwuY29tIiwiaWF0IjoxNTgwODQ0MTc0fQ.6s09oEfJrNutXoqgkbVRk_IwJXP2BMkiHGjF7qzppVY",
"uuid": "858afac0-28cd-4ea7-99ca-f262941a8a7e"
}(Obviously deletion_token and uuid are samples.)
Path ~/appowner/uuid/:uuid GET method.
~/appowner/uuid/858afac0-28cd-4ea7-99ca-f262941a8a7eResponses as
{
"firstname": "Jason",
"lastname": "Bourne",
"email": "[email protected]",
"deletion_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Impib3VybmVAZ21haWwuY29tIiwiaWF0IjoxNTgwODQ0MTc0fQ.6s09oEfJrNutXoqgkbVRk_IwJXP2BMkiHGjF7qzppVY",
"uuid": "858afac0-28cd-4ea7-99ca-f262941a8a7e"
}Path ~/appowner/emailpassword/:email/:password GET method.
~/appowner/emailpassword/[email protected]/theverymuchsecretpasswordofjasonbourneHas the same result of Path ~/appowner/uuid/:uuid GET method.
Path ~/appowner/delete DELETE method.
Send this to delete your stored owner
{
"deletion_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Impib3VybmVAZ21haWwuY29tIiwiaWF0IjoxNTgwODQ0MTc0fQ.6s09oEfJrNutXoqgkbVRk_IwJXP2BMkiHGjF7qzppVY",
"uuid" : "858afac0-28cd-4ea7-99ca-f262941a8a7e"
}Produces
{
"affectedRows": 1,
"insertId": 0,
"warningStatus": 0
}Path ~/appowner/update POST method.
Send
{
"uuid": "de54e724-d488-4f87-80a8-9ae754986e51",
"firstname": "Jason",
"lastname": "Bourne",
"email": "[email protected]",
"password": "otherpassword"
}To get the response
{
"status": 202,
"affectedRows": 1
}(The http status 202 means Accepted)
Path ~/applications/create POST method.
An owner cannot have more than one application with the same name.
Send this data to create an application
{
"owneruuid" : "de54e724-d488-4f87-80a8-9ae754986e51",
"appname": "my new and awsome app"
}To get the response
{
"created": true,
"appname": "my new and awsome app",
"creationdate": "2020-02-05",
"enddate": "2021-02-05T11:38:56.218Z",
"uuid": "17ac43a8-f3b9-40be-a3b4-9eaca99b529a",
"apiKey": "2YP47A5-YEWM1FG-MET9XB1-N6DN56N"
}Keep your apiKey in a very safe place, you will need it a lot.
Path ~/applications/delete DELETE method.
Send apiKey as follow to delete
{
"apikey" : "2YP47A5-YEWM1FG-MET9XB1-N6DN56N"
}It produces:
{
"affectedRows": 1,
"message": "All auth users of this application are deleted too"
}
When the app was deleted in fact, or
{
"affectedRows": 0,
"message": "nothing to delete"
}
In other case
Path ~/users/signup POST method.
To create a user for an due application:
{
"apikey": "DQKPV83-BBB4Y1P-NNTTXB1-D8V8NHC",
"username": "JBond",
"email": "[email protected]",
"password": "bond007"
}And this produces:
{
"apikey": "DQKPV83-BBB4Y1P-NNTTXB1-D8V8NHC",
"uuid": "6cb56f4e-c22e-4b6b-9072-a267044890fc",
"username": "JBond",
"email": "[email protected]",
"creationdate": "2020-02-06",
"enddate": "2021-02-06",
"active": true
}As you can guess, uuid is variable and its value depends on different factors.
Path ~/users/signin POST method.
The main proccess to sign in the application es this. Though, this is not the only. Send:
{
"uuid": "6cb56f4e-c22e-4b6b-9072-a267044890fc",
"apikey": "DQKPV83-BBB4Y1P-NNTTXB1-D8V8NHC"
}To get:
{
"auth": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxNzkxMSwiZXhwIjoxNTgxMTA0MzExfQ.dUpgzlw9NN7RI5SqUKMPlcF4EE6dfH_l9QduLoY5D8Y"
}By default the token will expires in one day.
Path ~/users/signwithemail POST method.
Other way to sing in is this method, when the user can be identified using its email, and password, and, obviously, the apikey. Send something like:
{
"apikey": "DQKPV83-BBB4Y1P-NNTTXB1-D8V8NHC",
"email": "[email protected]",
"password" : "bond007"
}To get the response:
{
"auth": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxODg1NywiZXhwIjoxNTgxMTA1MjU3fQ.mL1h4TwKSQilIcvDpK_jXs9k-4S-OczWU7rUJhx5byI",
"uuid": "6cb56f4e-c22e-4b6b-9072-a267044890fc"
}As you can see, the program send, besides, the uuid, for a better way to do login!
Path ~/users/islogged/:token GET method.
Compose the url like above. for example:
http://your_domain.com/users/islogged/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxODg1NywiZXhwIjoxNTgxMTA1MjU3fQ.mL1h4TwKSQilIcvDpK_jXs9k-4S-OczWU7rUJhx5byI
To get
{
"auth": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxODg1NywiZXhwIjoxNTgxMTA1MjU3fQ.mL1h4TwKSQilIcvDpK_jXs9k-4S-OczWU7rUJhx5byI"
}Path ~/users/userdata POST method.
To get private userdata send the token as:
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxODg1NywiZXhwIjoxNTgxMTA1MjU3fQ.mL1h4TwKSQilIcvDpK_jXs9k-4S-OczWU7rUJhx5byI"
}To get some like:
{
"apikey": "DJTPYKH-R8Q4PTX-J1SA4SV-0H491Z4",
"uuid": "6cb56f4e-c22e-4b6b-9072-a267044890fc",
"username": "JBond",
"email": "[email protected]",
"creationdate": "2020-02-05",
"enddate": "2021-02-05",
"active": true
}Path ~/users/update PUT method.
This is the way to update userdata, send
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjYjU2ZjRlLWMyMmUtNGI2Yi05MDcyLWEyNjcwNDQ4OTBmYyIsImlhdCI6MTU4MTAxODg1NywiZXhwIjoxNTgxMTA1MjU3fQ.mL1h4TwKSQilIcvDpK_jXs9k-4S-OczWU7rUJhx5byI",
"username": "JAMESBOND",
"email": "[email protected]",
"active": true,
"password" : "attheserviceofhisgracefulmajesty"
}To get
{
"done": true,
"username": "JAMESBOND",
"email": "[email protected]"
}Path ~/ GET method.
Shows this page
Copyleft 
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent