API endpoint to get all custom-permissions of role #5283

New Issue

OVERLORD · 2026-02-05T09:54:11+03:00

OVERLORD commented

2026-02-05 09:54:11 +03:00

Originally created by @Rob787 on GitHub (May 16, 2025).

Describe the feature you'd like

Due to the limitation that OIDC tokens cannot be used yet to authenticate to the API (will submit a separate feature request), we are trying to integrate content of our Bookstack environment in an web application via another way.

In this case we created a "service-user" with API token, that can fetch content via the API. However, we are having one challenge: determine the content a certain role has access to.

Currently the only endpoint provided is the: https://bookstack.bassopaolo.com/api/docs#content-permissions-read
For which we always need to provide a specific shelf/book or pageid.

However, I would like to request an endpoint, where I can, based on role_id, get a list of all content permissions. Such that when requesting a list of shelves, we can filter out the shelves a role is entitled to to see for instance.

Describe the benefits this would bring to existing BookStack users

Easier to determine if user is allowed to see specific list of content based on role.

Can the goal of this request already be achieved via other means?

Yes, by looping through requested list of content and request content-permission for each specific shelf/book/page.

Have you searched for an existing open/closed issue?

I have searched for existing issues and none cover my fundamental request

How long have you been using BookStack?

1 to 5 years

Additional context

No response

Originally created by @Rob787 on GitHub (May 16, 2025). ### Describe the feature you'd like Due to the limitation that OIDC tokens cannot be used yet to authenticate to the API (will submit a separate feature request), we are trying to integrate content of our Bookstack environment in an web application via another way. In this case we created a "service-user" with API token, that can fetch content via the API. However, we are having one challenge: determine the content a certain role has access to. Currently the only endpoint provided is the: https://bookstack.bassopaolo.com/api/docs#content-permissions-read For which we always need to provide a specific shelf/book or pageid. However, I would like to request an endpoint, where I can, based on role_id, get a list of all content permissions. Such that when requesting a list of shelves, we can filter out the shelves a role is entitled to to see for instance. ### Describe the benefits this would bring to existing BookStack users Easier to determine if user is allowed to see specific list of content based on role. ### Can the goal of this request already be achieved via other means? Yes, by looping through requested list of content and request content-permission for each specific shelf/book/page. ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundamental request ### How long have you been using BookStack? 1 to 5 years ### Additional context _No response_

OVERLORD added the 🔨 Feature Request label 2026-02-05 09:54:11 +03:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5283