docs: define the authorization catalog API - #425
Conversation
|
Thanks for the pull request, @mariajgrimaldi! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
rodmgwgu
left a comment
There was a problem hiding this comment.
Thanks for this!, looks good, just the same nit as the others on the subtitle numbers.
c4ad899 to
4b86347
Compare
ee5bb20 to
a3e80ce
Compare
a3e80ce to
cfe0e2b
Compare
cfe0e2b to
b6bf587
Compare
| * supported scope namespaces; | ||
| * complete permission identifiers; | ||
| * whether the role is ``static`` or ``user_defined``; and | ||
| * whether the caller may edit or delete the definition. |
There was a problem hiding this comment.
What would this property be used for?
b6bf587 to
2ae4bcc
Compare
2ae4bcc to
458f5bb
Compare
458f5bb to
53f1612
Compare
53f1612 to
2d8b2a2
Compare
Description
The existing roles endpoint returns role and permission identifiers from Casbin, but it does not return the display names, descriptions, categories, icons, or definition source needed by clients. Frontends therefore keep their own copies, so a role contributed by an application can still require a frontend release.
This ADR extends the AuthZ APIs to return the authorization definitions stored in the authz model. Clients can use the same endpoint for static and user-defined roles, receive translated display metadata, and continue using the existing response fields.
Merge checklist:
Check off if complete or not applicable: