Examples

The following examples demonstrate how to interact with a resource in the API via HTTP. This section uses the Permission resource as an example to showcase various operations.

For these examples, it is assumed that the backend application is running at http://localhost:3001.
Make sure to replace Bearer *** with a valid access token in all requests.
For a complete list of API endpoints and detailed specifications, visit the Swagger documentation at:
http://localhost:3001/docs

GET Collection

You can fetch a list of permissions using the following cURL command:

curl -X GET 'http://localhost:3001/permissions' \
  -H 'Authorization: Bearer ***'

Response

{
    "data": [
        {
            "id": "xxx",
            "built_in": true,
            "name": "user_read",
            "display_name": "Read Users",
            "description": "Allows reading user data."
        },
        {
            "id": "xxx",
            "built_in": true,
            "name": "role_edit",
            "display_name": "Manage Roles",
            "description": "Allows updating roles."
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 200
    }
}

GET Record

To fetch details of a specific permission by its id or name:

curl -X GET 'http://localhost:3001/permissions/user_read' \
  -H 'Authorization: Bearer ***'

Response

{
    "id": "xxx",
    "built_in": true,
    "name": "user_read",
    "display_name": "Read Users",
    "description": "Allows reading user data."
}

CREATE Record

To create a new permission, send a POST request with the necessary details:

curl -X POST 'http://localhost:3001/permissions' \
  -H 'Authorization: Bearer ***' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "profile_edit",
        "display_name": "Edit Profile",
        "description": "Allows users to edit their own profile."
      }'

Response

{
  "id": "***",
  "built_in": false,
  "name": "profile_edit",
  "display_name": "Edit Profile",
  "description": "Allows users to edit their own profile."
}

UPDATE Record

To update an existing permission by its id or name:

curl -X POST 'http://localhost:3001/permissions/profile_edit' \
  -H 'Authorization: Bearer ***' \
  -H 'Content-Type: application/json' \
  -d '{
        "display_name": "Modify Profile",
        "description": "Allows users to modify their own profile information."
      }'

Response

{
  "id": "***",
  "built_in": false,
  "name": "profile_edit",
  "display_name": "Modify Profile",
  "description": "Allows users to modify their own profile information."
}

DELETE Record

To delete a permission by its id or name:

curl -X DELETE 'http://localhost:3001/permissions/profile_edit' \
  -H 'Authorization: Bearer ***'

Response

{
  "id": "***",
  "built_in": false,
  "name": "profile_edit",
  "display_name": "Modify Profile",
  "description": "Allows users to modify their own profile information."
}