03. check login register api

with a Postman API documentation for the authentication module we’ve created, including JSON code examples for each endpoint. This documentation will use http://localhost:5000/api/auth/ as the base URL.

Here’s the Postman API documentation for your authentication module:

1. User Registration
2. URL: http://localhost:5000/api/auth/register
3. Method: POST
4. Body (raw JSON):

{
  "username": "newuser",
  "email": "newuser@example.com",
  "password": "password123"
}

4. Response (201 Created):

{
  "message": "User registered successfully!",
  "userId": 1
}

2. User Login
3. URL: http://localhost:5000/api/auth/login
4. Method: POST
5. Body (raw JSON):

{
  "username": "newuser",
  "password": "password123"
}

4. Response (200 OK):

{
  "id": 1,
  "username": "newuser",
  "email": "newuser@example.com",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Protected Route Example

• URL: http://localhost:5000/api/auth/protected
• Method: GET
• Headers:
• x-access-token: <your_jwt_token>
• Response (200 OK):

{
  "message": "This is a protected route."
}

Admin Route Example

• URL: http://localhost:5000/api/auth/admin
• Method: GET
• Headers:
• x-access-token: <your_jwt_token>
• Response (200 OK):

{
  "message": "This is an admin route."
}

3. Create Group
4. URL: http://localhost:5000/api/auth/groups
5. Method: POST
6. Headers:
7. x-access-token: <your_jwt_token>
8. Body (raw JSON):

{
  "name": "Administrators"
}

5. Response (201 Created):

{
  "id": 1,
  "name": "Administrators"
}

4. Get All Groups
5. URL: http://localhost:5000/api/auth/groups
6. Method: GET
7. Headers:
8. x-access-token: <your_jwt_token>
9. Response (200 OK):

[
  {
    "id": 1,
    "name": "Administrators"
  },
  {
    "id": 2,
    "name": "Users"
  }
]

5. Get Group by ID
6. URL: http://localhost:5000/api/auth/groups/1
7. Method: GET
8. Headers:
9. x-access-token: <your_jwt_token>
10. Response (200 OK):

{
  "id": 1,
  "name": "Administrators"
}

6. Update Group
7. URL: http://localhost:5000/api/auth/groups/1
8. Method: PUT
9. Headers:
10. x-access-token: <your_jwt_token>
11. Body (raw JSON):

{
  "name": "Super Administrators"
}

5. Response (200 OK):

{
  "id": 1,
  "name": "Super Administrators"
}

7. Delete Group
8. URL: http://localhost:5000/api/auth/groups/1
9. Method: DELETE
10. Headers:
11. x-access-token: <your_jwt_token>
12. Response (200 OK):

{
  "message": "Group deleted successfully."
}

8. Create Permission
9. URL: http://localhost:5000/api/auth/permissions
10. Method: POST
11. Headers:
12. x-access-token: <your_jwt_token>
13. Body (raw JSON):

{
  "name": "Can view users",
  "codename": "view_users"
}

5. Response (201 Created):

{
  "id": 1,
  "name": "Can view users",
  "codename": "view_users"
}

9. Get All Permissions
10. URL: http://localhost:5000/api/auth/permissions
11. Method: GET
12. Headers:
13. x-access-token: <your_jwt_token>
14. Response (200 OK):

[
  {
    "id": 1,
    "name": "Can view users",
    "codename": "view_users"
  },
  {
    "id": 2,
    "name": "Can edit users",
    "codename": "edit_users"
  }
]

10. Get Permission by ID
11. URL: http://localhost:5000/api/auth/permissions/1
12. Method: GET
13. Headers:
14. x-access-token: <your_jwt_token>
15. Response (200 OK):

{
  "id": 1,
  "name": "Can view users",
  "codename": "view_users"
}

11. Update Permission
12. URL: http://localhost:5000/api/auth/permissions/1
13. Method: PUT
14. Headers:
15. x-access-token: <your_jwt_token>
16. Body (raw JSON):

{
  "name": "Can view and edit users",
  "codename": "view_edit_users"
}

5. Response (200 OK):

{
  "id": 1,
  "name": "Can view and edit users",
  "codename": "view_edit_users"
}

12. Delete Permission
13. URL: http://localhost:5000/api/auth/permissions/1
14. Method: DELETE
15. Headers:
16. x-access-token: <your_jwt_token>
17. Response (200 OK):

{
  "message": "Permission deleted successfully."
}

13. Assign Permission to Group
14. URL: http://localhost:5000/api/auth/groups/1/permissions
15. Method: POST
16. Headers:
17. x-access-token: <your_jwt_token>
18. Body (raw JSON):

{
  "permissionId": 2
}

5. Response (200 OK):

{
  "message": "Permission assigned to group successfully."
}

14. Remove Permission from Group
15. URL: http://localhost:5000/api/auth/groups/1/permissions/2
16. Method: DELETE
17. Headers:
18. x-access-token: <your_jwt_token>
19. Response (200 OK):

{
  "message": "Permission removed from group successfully."
}

Assign multiple permissions to a group:

• URL: http://localhost:5000/api/auth/groups/1/permissions/bulk
• Method: POST
• Headers:
• x-access-token: <your_jwt_token>
• Body (raw JSON):

{
  "permissionIds": [1, 2, 3, 4]

Response (200 OK):

Remove multiple permissions from a group:

• URL: http://localhost:5000/api/auth/groups/1/permissions/bulk
• Method: DELETE
• Headers:
• x-access-token: <your_jwt_token>
• Body (raw JSON):

{
  "permissionIds": [2, 4]
}

{
  "message": "Permissions removed from group successfully."
}

15. Assign Permission to User
16. URL: http://localhost:5000/api/auth/users/1/permissions
17. Method: POST
18. Headers:
19. x-access-token: <your_jwt_token>
20. Body (raw JSON):

{
  "permissionId": 2
}

5. Response (200 OK):

{
  "message": "Permission assigned to user successfully."
}

16. Remove Permission from User
17. URL: http://localhost:5000/api/auth/users/1/permissions/2
18. Method: DELETE
19. Headers:
20. x-access-token: <your_jwt_token>
21. Response (200 OK):

{
  "message": "Permission removed from user successfully."

Assign multiple permissions to a user:

• URL: http://localhost:5000/api/auth/users/1/permissions/bulk
• Method: POST
• Headers:
• x-access-token: <your_jwt_token>
• Body (raw JSON):

{
  "permissionIds": [1, 3, 5]
}

Remove multiple permissions from a user:

• URL: http://localhost:5000/api/auth/users/1/permissions/bulk
• Method: DELETE
• Headers:
• x-access-token: <your_jwt_token>
• Body (raw JSON):

{
  "permissionIds": [3, 5]
}

17. Protected Route Example
18. URL: http://localhost:5000/api/auth/protected
19. Method: GET
20. Headers:
21. x-access-token: <your_jwt_token>
22. Response (200 OK):

{
  "message": "This is a protected route."
}

18. Admin Route Example
19. URL: http://localhost:5000/api/auth/admin
20. Method: GET
21. Headers:
22. x-access-token: <your_jwt_token>
23. Response (200 OK):

{
  "message": "This is an admin route."
}

To use these endpoints in Postman:

1. Create a new request for each endpoint.
2. Set the HTTP method and URL as specified.
3. For routes requiring authentication, add the x-access-token header with the JWT token you received from the login route.
4. For POST and PUT requests, set the body to “raw” and select JSON format, then input the provided JSON payload.
5. Send the request and check the response.

Remember to replace any placeholder IDs (like :id, :userId, :groupId, :permissionId) with actual IDs when testing these endpoints. Also, ensure your server is running on http://localhost:5000 before testing these endpoints.