docs: add PAT and organization flow equivalency documentation #1187
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
Developers were confused about how Personal Access Tokens (PATs) work with organization-related access controls. The existing documentation mentioned that PATs can grant access tokens, but didn't clarify that these tokens work identically to those obtained through the standard
refresh_token
flow, especially for organization permissions and organization-level API resources.Solution
Added comprehensive documentation to clarify the equivalency between PAT tokens and refresh tokens for organization contexts:
1. Enhanced PAT Documentation
Added a prominent tip in the PAT documentation explaining that access tokens obtained via PATs work identically to refresh tokens:
Key points clarified:
2. Cross-references to Organization Documentation
Added a new "Organization support" section in PAT docs with direct links to:
organization_id
parameter3. Restructured Related Resources
Enhanced the related resources section by:
Impact
Commit Compliance
This PR follows the conventional commit format required by the repository's commitlint configuration:
docs: add PAT and organization flow equivalency documentation
type: description
(conventional commits standard)docs
(for documentation changes)Files Changed
docs/user-management/personal-access-token.mdx
- Added equivalency tip and organization support section (23 lines added)The changes maintain backward compatibility while providing essential clarity for developers working with organization-scoped authentication flows.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.