[Doc] Improve Access Control for Custom Pages #10357
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fzaninotto
commented
Nov 18, 2024
|
|
||
| export const LogsPage = () => ( | ||
| <Authenticated> | ||
| <CanAccess resource="logs" action="read" accessDenied={<AccessDenied />}> |
There was a problem hiding this comment.
The important part is the accessDenied={<AccessDenied />} part, which was missing.
djhi
reviewed
Nov 18, 2024
| **Note**: You don't need to use `<CanAccess>` on the core react-admin page components (`<List>`, `<Create>`, `<Edit>`, `<Show>`) because they already have built-in access control. | ||
|
|
||
| **Note**: You don't need to use `<CanAccess>` on custom pages if your admin uses [`requireAuth`](./Admin.md#requireauth). | ||
| **Note**: You don't need to use `<Authenticated>` on custom pages if your admin uses [`requireAuth`](./Admin.md#requireauth). |
There was a problem hiding this comment.
I'd move that tip below the example that uses <Authenticated>
There was a problem hiding this comment.
I thought about that, too, but I feel that it interrupts the flow of the explanation for a particular case. So I'm -1 for this change.
djhi
approved these changes
Nov 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The current doc for securing custom pages with access control misses two things:
Solution
Improve the doc