Laravel Micro Service Auth With Jwt"

Getting started
Documentation

Getting startd

References

Laravel Micro Service Auth With Jwt use Zizaco/Entrust package to Users ACL

Clone Repository

git clone https://github.com/MedeirosDev/laravel-microservice-auth-with-jwt.git

Up Project

Up Containers

docker-compose up -d

Update project dependences

docker exec -it api-users-app composer update

copy .env.example to .env

docker exec -it api-users-app cp .env.example .env

Generate hash Jwt

docker exec -it api-users-app php artisan jwt:secret

Clear cache

docker exec -it api-users-app php artisan cache:clear && composer dumpautoload

Run Migrations with seeders

docker exec -it api-users-app php artisan migrate:refresh --seed

Documentation

Allowed verbs

GET, POST, PUT, PATCH ou DELETE

Required in the header of all requests

Content-Type: application/json
Accept: application/json

Required hash in the Header of all requisitions that need to be authorized

Insert your generated hash

Authorization: Bearer YourGeneratedHash

Authentication

POST /auth/login - Login

Request

Content-Type: application/json
Accept: application/json
{
    "email": "smedeiros.flavio@gmail.com",
    "password": "secret"
}

Response

{
    "access_token": "YourGeneratedHash",
    "token_type": "bearer",
    "expires_in": 3600
}

Getting resource with required authorization

GET /auth/me - Return my information

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "Flávio Medeiros",
    "email": "smedeiros.flavio@gmail.com",
    "email_verified_at": "2019-07-01 19:44:02",
    "created_at": "2019-06-18 18:35:07",
    "updated_at": "2019-07-01 19:44:03"
}

Resources

Without authentication

Register User

POST /register/create - Register a new user

Request

Content-Type: application/json
Accept: application/json
{
    "name": "Flávio Medeiros",
    "email": "mail@example.com",
    "password": "secret"
}

Response

{
    "message": "Access your email to verify your account"
}

Send email verification

POST /register/send_email_verification/{email} - Send email for account verification

Request

Content-Type: application/json
Accept: application/json
{ }

Response

{
    "message": "Access your email to verify your account"
}

Recovery account

POST /register/recovery/{email} - Send password recovery email

Request

Content-Type: application/json
Accept: application/json
{
	"url": "http://callback/url"
}

Response

{
    "message": "Access your email to recovery your password"
}

Change password

PUT /register/change_password/?token={token} - Makes password change after password recovery email

Request

Content-Type: application/json
Accept: application/json
{
	"password": "secret"
}

With authentication

Logout

POST /auth/logout - Logout

Request

Content-Type: application/json
Accept: application/json
{ }

Response

{
    "message": "Successfully logged out"
}

Refresh jwt

POST /auth/refresh - Refresh Jwt

Request

Content-Type: application/json
Accept: application/json
{ }

Response

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9kZXYuZG9ja2VyLmNvbTo4MDAwXC9hdXRoXC9yZWZyZXNoIiwiaWF0IjoxNTYyMzYxODYxLCJleHAiOjE1NjIzNjU0NjEsIm5iZiI6MTU2MjM2MTg2MSwianRpIjoiVzViNGF1OEFyMlI5QzVLRCIsInN1YiI6MSwicHJ2IjoiMTNlOGQwMjhiMzkxZjNiN2I2M2YyMTkzM2RiYWQ0NThmZjIxMDcyZSJ9.5fhTO50P4Q3F_f_WoKb5fgIBB4aMNRA9xx6KrrarU8k",
    "token_type": "bearer",
    "expires_in": 3600
}

Users

GET /users - Returns all users currently available

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "Flávio Medeiros",
            "email": "smedeiros.flavio@gmail.com",
            "email_verified_at": "2019-07-01 19:44:02",
            "created_at": "2019-06-18 18:35:07",
            "updated_at": "2019-07-01 19:44:03"
        }
    ],
    "first_page_url": "http://127.0.0.1:8000/users?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://127.0.0.1:8000/users?page=1",
    "next_page_url": null,
    "path": "http://127.0.0.1:8000/users",
    "per_page": 15,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

POST /users - Add User

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "Flavio Medeiros",
    "email": "example@mail.com",
    "password": "secret"
}

Response

{
    "message": "Access your email to verify your account"
}

GET /users/{id} - Show User

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "Flávio Medeiros",
    "email": "smedeiros.flavio@gmail.com",
    "email_verified_at": "2019-07-01 19:44:02",
    "created_at": "2019-06-18 18:35:07",
    "updated_at": "2019-07-01 19:44:03"
}

PUT /users/{id} - Updates all fields for User

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "Flavio Medeiros",
    "email": "example@mail.com",
    "password": "secret"
}

Response

{
    "id": 1,
    "name": "Flávio Medeiros",
    "email": "example@mail.com",
    "email_verified_at": "2019-07-01 19:44:02",
    "created_at": "2019-06-18 18:35:07",
    "updated_at": "2019-07-05 21:30:56"
}

PATCH /users/{id} - Updates one or more user fields a User

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "Flavio da Silva Medeiros",
    ...
}

Response

{
    "id": 1,
    "name": "Flávio da Silva Medeiros",
    "email": "smedeiros.flavio@gmail.com",
    "email_verified_at": "2019-07-05 21:37:30",
    "created_at": "2019-07-05 21:37:30",
    "updated_at": "2019-07-05 21:37:49"
}

DELETE /users/{id} - Delete User

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "Flávio da Silva Medeiros",
    "email": "smedeiros.flavio@gmail.com",
    "email_verified_at": "2019-07-05 21:37:30",
    "created_at": "2019-07-05 21:37:30",
    "updated_at": "2019-07-05 21:37:49"
}

GET /users/{id}/roles - Show user roles

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "admin",
            "display_name": "Administrator",
            "description": "Administrator of system.",
            "created_at": "2019-07-10 11:41:27",
            "updated_at": null,
            "user_id": 1,
            "role_id": 1
        }
    ],
    "first_page_url": "http://127.0.0.1:8000/users/1/roles?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://127.0.0.1:8000/users/1/roles?page=1",
    "next_page_url": null,
    "path": "http://127.0.0.1:8000/users/1/roles",
    "per_page": 15,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

PUT /users/{id}/roles - Update all user roles

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "roles": [
	    1
    ]
}

Response

[
    {
        "id": 1,
        "name": "admin",
        "display_name": "Administrator",
        "description": "Administrator of system.",
        "created_at": "2019-07-10 11:41:27",
        "updated_at": null,
        "pivot": {
            "user_id": 1,
            "role_id": 1
        }
    }
]

Roles

GET /roles - Returns all roles currently available

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "admin",
            "display_name": "Administrator",
            "description": "Administrator of system.",
            "created_at": "2019-07-10 11:41:27",
            "updated_at": null
        }
    ],
    "first_page_url": "http://127.0.0.1:8000/roles?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://127.0.0.1:8000/roles?page=1",
    "next_page_url": null,
    "path": "http://127.0.0.1:8000/roles",
    "per_page": 15,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

POST /roles - Add Role

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "Test",
    "display_name": "Test.",
    "description": "Test Role"
}

Response

{
    "name": "Test",
    "display_name": "Test.",
    "description": "Test Role",
    "updated_at": "2019-07-10 11:53:03",
    "created_at": "2019-07-10 11:53:03",
    "id": 2
}

GET /roles/{id} - Show Role

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "admin",
    "display_name": "Administrator",
    "description": "Administrator of system.",
    "created_at": "2019-07-10 11:41:27",
    "updated_at": null
}

PUT /roles/{id} - Updates all fields for Role

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "administrator",
    "display_name": "Administrator",
    "description": "Administrator of AppExample"
}

Response

{
    "id": 1,
    "name": "administrator",
    "display_name": "Administrator",
    "description": "Administrator of AppExample",
    "created_at": "2019-07-10 11:41:27",
    "updated_at": "2019-07-10 11:56:34"
}

PATCH /roles/{id} - Updates one or more user fields a Role

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
	"name": "adm",
    "display_name": "Admin..."
}

Response

{
    "id": 1,
    "name": "adm",
    "display_name": "Admin...",
    "description": "Administrator of AppExample",
    "created_at": "2019-07-10 11:41:27",
    "updated_at": "2019-07-10 11:58:09"
}

DELETE /roles/{id} - Delete Role

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "adm",
    "display_name": "Admin...",
    "description": "administrator system 123",
    "created_at": "2019-07-10 11:41:27",
    "updated_at": "2019-07-10 11:58:09"
}

GET /roles/{id}/permissions - Show role permissions

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "users.read",
            "display_name": "Users / Show",
            "description": null,
            "created_at": "2019-07-10 11:59:31",
            "updated_at": null,
            "permission_id": 1,
            "role_id": 1
        },
        {
            "id": 2,
            "name": "users.store",
            "display_name": "Users / Store",
            "description": null,
            "created_at": "2019-07-10 11:59:31",
            "updated_at": null,
            "permission_id": 2,
            "role_id": 1
        },
        ...
    ],
    "first_page_url": "http://127.0.0.1:8000/roles/1/permissions?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http://127.0.0.1:8000/roles/1/permissions?page=2",
    "next_page_url": "http://127.0.0.1:8000/roles/1/permissions?page=2",
    "path": "http://127.0.0.1:8000/roles/1/permissions",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 16
}

PUT /roles/{id}/permissions - Update all role permissions

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
	"permissions": [
		1,
		2,
		3
	]
}

Response

[
    {
        "id": 1,
        "name": "users.read",
        "display_name": "Users / Show",
        "description": null,
        "created_at": "2019-07-10 12:05:44",
        "updated_at": null,
        "pivot": {
            "role_id": 1,
            "permission_id": 1
        }
    },
    {
        "id": 2,
        "name": "users.store",
        "display_name": "Users / Store",
        "description": null,
        "created_at": "2019-07-10 12:05:44",
        "updated_at": null,
        "pivot": {
            "role_id": 1,
            "permission_id": 2
        }
    },
    ...
]

Permissions

GET /permissions - Returns all permissions available

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "users.read",
            "display_name": "Users / Show",
            "description": null,
            "created_at": "2019-07-10 12:09:48",
            "updated_at": null
        },
        {
            "id": 2,
            "name": "users.store",
            "display_name": "Users / Store",
            "description": null,
            "created_at": "2019-07-10 12:09:48",
            "updated_at": null
        },
        ...
    ],
    "first_page_url": "http://127.0.0.1:8000/permissions?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http://127.0.0.1:8000/permissions?page=2",
    "next_page_url": "http://127.0.0.1:8000/permissions?page=2",
    "path": "http://127.0.0.1:8000/permissions",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 16
}

POST /permissions - Add Permission

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "permission.test",
    "display_name": "permission of test.",
    "description": "only test"
}

Response

{
    "name": "permission.test",
    "display_name": "permission of test.",
    "description": "only test",
    "updated_at": "2019-07-10 12:13:19",
    "created_at": "2019-07-10 12:13:19",
    "id": 17
}

GET /permissions/{id} - Show Permission

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 1,
    "name": "users.read",
    "display_name": "Users / Show",
    "description": null,
    "created_at": "2019-07-10 12:09:48",
    "updated_at": null
}

PUT /permissions/{id} - Updates all fields for Permission

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "name": "permission.test",
    "display_name": "permission of test...",
    "description": "only test..."
}

Response

{
    "id": 17,
    "name": "permission.test",
    "display_name": "permission of test...",
    "description": "only test...",
    "created_at": "2019-07-10 12:13:19",
    "updated_at": "2019-07-10 12:17:21"
}

PATCH /permissions/{id} - Updates one or more fields of Permission

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{
    "display_name": "permission of test ..."
}

Response

{
    "id": 17,
    "name": "permission.test",
    "display_name": "permission of test ...",
    "description": "only test...",
    "created_at": "2019-07-10 12:13:19",
    "updated_at": "2019-07-10 12:18:22"
}

DELETE /permission/{id} - Delete Permission

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer YourGeneratedHash
{ }

Response

{
    "id": 17,
    "name": "permission.test",
    "display_name": "permission of test ...",
    "description": "only test...",
    "created_at": "2019-07-10 12:13:19",
    "updated_at": "2019-07-10 12:18:22"
}

###Filter / Select / Paginate / Sort

Filter

Allow filters , eq, lt, lte, gt, gte, like, regex

Obs: references of `eq`

Use and eq in field filter display_name

and eq Filter by equals

http://dev.docker.com:8000/permissions?display_name=Users / Update

http://dev.docker.com:8000/permissions?display_name[eq]=Users / Update

Use lt in field filter created_at

lt Filter by less

http://dev.docker.com:8000/permissions?created_at[lt]=2019-07-11

http://dev.docker.com:8000/permissions?created_at[lt]=2019-07-11 12:30

Use lte in field filter created_at

lte Filter by less or equal

http://dev.docker.com:8000/permissions?created_at[lte]=2019-07-11

http://dev.docker.com:8000/permissions?created_at[lte]=2019-07-11 12:30

Use gt in field filter updated_at

gt Filter by greater

http://dev.docker.com:8000/permissions?updated_at[gt]=2019-07-11

http://dev.docker.com:8000/permissions?updated_at[gt]=2019-07-11 12:30

Use gte in field filter updated_at

gte Filter by greater or equal

http://dev.docker.com:8000/permissions?updated_at[gte]=2019-07-11

http://dev.docker.com:8000/permissions?updated_at[gte]=2019-07-11 12:30

Use lte and gte in field filter created_at

lte Filter by less or equal

gte Filter by greater or equal

http://dev.docker.com:8000/permissions?created_at[lte]=2019-07-11&created_at[gte]=2019-06-11
produce =>   created_at <= 2019-07-11 && created_at >= 2019-06-11

Use like in field filter display_name

like Filter by contains

http://dev.docker.com:8000/permissions?display_name[like]=Users

http://dev.docker.com:8000/permissions?display_name[like]=Store

Use regex in field filter name

regex Filter by regular expression - https://dev.mysql.com/doc/refman/5.6/en/regexp.html

http://dev.docker.com:8000/permissions?name[regex]=[a-z\\.]

http://dev.docker.com:8000/permissions?name[regex]=[0-9]

Select

select specific fields for resources

http://dev.docker.com:8000/permissions?fields=name,display_name

Response

{
    "current_page": 1,
    "data": [
        {
            "name": "users.read",
            "display_name": "Users / Show"
        },
        {
            "name": "users.store",
            "display_name": "Users / Store"
        },
        {
            "name": "users.update",
            "display_name": "Users / Update"
        },
        ...
    ],
    "first_page_url": "http://dev.docker.com:8000/permissions?fields=name,display_name&page=1",
    ...
}

Paginate

Paginate Data

per_page default: 15 - Accept all to return all results

page default: 1

http://dev.docker.com:8000/permissions?page=1&per_page=15
http://dev.docker.com:8000/permissions

http://dev.docker.com:8000/permissions?page=2&per_page=15
http://dev.docker.com:8000/permissions?page=2

http://dev.docker.com:8000/permissions?per_page=all

Sort

Sort Data

ASC => or +

DESC => -

http://dev.docker.com:8000/permissions?sort=name,-display_name
http://dev.docker.com:8000/permissions?sort=+name,-display_name

http://dev.docker.com:8000/permissions?sort=+created_at

http://dev.docker.com:8000/permissions?sort=-updated_at,+created_at

http://dev.docker.com:8000/permissions?sort=-name,-created_at

Combine Tools

Combine filter, select, paginate and sort data

http://dev.docker.com:8000/permissions?
    fields=name,display_name&
    name[like]=user&
    sort=-name&
    per_page=30&
    page=1

http://dev.docker.com:8000/permissions?
    fields=name,display_name,created_at&
    name[like]=user&
    sort=-name&
    per_page=30

http://dev.docker.com:8000/permissions?
    fields=name,display_name,created_at&
    name[gte]=2019-06-10&
    sort=-updated_at&
    per_page=all

anderson-mota/laravel-microservice-auth-with-jwt

Laravel Micro Service Auth With Jwt"

Table of contents

Getting startd

References

Clone Repository

Up Project

Documentation

Allowed verbs

Required in the header of all requests

Required hash in the Header of all requisitions that need to be authorized

Authentication

Getting resource with required authorization

Resources

Without authentication

Register User

Send email verification

Recovery account

Change password

With authentication

Logout

Refresh jwt

Users

Roles

Permissions

Filter

Obs: references of `eq`

Select

Paginate

Sort

Combine Tools

anderson-mota/laravel-microservice-auth-with-jwt

Laravel Micro Service Auth With Jwt"

Table of contents

Getting startd

References

Clone Repository

Up Project

Documentation

Allowed verbs

Required in the header of all requests

Required hash in the Header of all requisitions that need to be authorized

Authentication

Getting resource with required authorization

Resources

Without authentication

Register User

Send email verification

Recovery account

Change password

With authentication

Logout

Refresh jwt

Users

Roles

Permissions

Filter

Obs: references of eq

Select

Paginate

Sort

Combine Tools

Obs: references of `eq`