docs(fga): fine-grained authorization reference and v2.3.0 changes#63
Open
lakhansamani wants to merge 8 commits into
Open
docs(fga): fine-grained authorization reference and v2.3.0 changes#63lakhansamani wants to merge 8 commits into
lakhansamani wants to merge 8 commits into
Conversation
…_session, validate_jwt_token
✅ Deploy Preview for authorizerdev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents the fine-grained authorization (FGA) feature shipped in
authorizerdev/authorizerPR #607.docs/core/authorization.mdcovering the model (Resources / Scopes / Policies / Permissions), per-callrequired_permissionsadoption, admin GraphQL mutations,my_permissionsquery, decision strategies, principal types, observability, caching, and a rollout checklist.docs/core/graphql-api.md— adds the newrequired_permissionsfield to the request-param tables forsession,validate_jwt_token, andvalidate_session(plus refreshed sample queries), the newmy_permissionsquery, and an Admin Authorization mutations subsection covering_add_resource/_add_scope/_add_policy/_add_permission(+ list / update / delete for each).docs/core/metrics-monitoring.md— new Authorization Metrics table coveringauthorizer_required_permissions_checks_total{endpoint, outcome}, the relabelledauthorizer_authz_checks_total{result}, and the now-labellessauthorizer_authz_unmatched_total. Adds a PromQL adoption query and an alerting rule foroutcome="error".docs/core/server-config.md— documents--authorization-cache-ttl,--include-permissions-in-token, and--authorization-log-all-checks. States the always-enforcing posture explicitly. No deprecation copy for--authorization-enforcementsince that flag never shipped.docs/core/security.md— short cross-link to the new authorization page explaining the always-enforcing default.docs/migration/v1-to-v2.md— adds an "Authorization (FGA)" section framing FGA as a v2 feature (not a migration) with an adoption checklist.sidebars.ts— registerscore/authorizationin the Core category betweensecurityanddatabases.Pairs with
Build status
npm run build— clean. Pre-existing broken links incore/sso-guideare not from this PR.Test plan
npm run buildclean (only pre-existing sso-guide broken links)../authorization#...,./metrics-monitoring#authorization-metrics,../migration/v1-to-v2).npm start) — eyeball the new page renders + sidebar entry.