feat: add On-Behalf-Of Token Exchange API documentation#1303
Merged
Conversation
Add comprehensive API documentation for the On-Behalf-Of (OBO) Token Exchange endpoint that enables middle-tier services to preserve user identity and permissions when calling downstream APIs. Changes: - Created new API documentation at /api/authentication/on-behalf-of-token-exchange/get-token - Documents the POST /oauth/token endpoint with grant_type token-exchange for OBO flows - Includes detailed parameter descriptions, request/response examples, and remarks - Updated navigation config for English, French (fr-ca), and Japanese (ja-jp) locales - Follows existing authentication API documentation structure and conventions The documentation covers: - RFC 8693 token exchange for preserving user identity in microservices - Actor claim delegation chain tracking - Custom API client prerequisites - Rate limits and caching best practices - RBAC-based scope filtering Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- Simplified description to focus on core functionality - Fixed typo: removed duplicate "to" in main description - Added more specific Custom API client requirements in remarks - Improved internal linking with proper relative URLs - Updated error response to reflect correct max delegation chain depth (5) - Enhanced parameter descriptions and documentation links Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
Summary
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
forrest-ua
approved these changes
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
avanscoy
reviewed
Jun 10, 2026
Co-authored-by: Amanda VS <amanda.vanscoy@auth0.com>
avanscoy
approved these changes
Jun 11, 2026
agiannelli-auth0
approved these changes
Jun 12, 2026
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
4 participants
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
Add comprehensive API documentation for the On-Behalf-Of (OBO) Token Exchange endpoint that enables middle-tier services to preserve user identity and permissions when calling downstream APIs.
Changes
/api/authentication/on-behalf-of-token-exchange/get-tokenPOST /oauth/tokenendpoint withgrant_type: token-exchangefor OBO flowsDocumentation Coverage
grant_type,subject_token,subject_token_type,requested_token_type,client_id,client_secret,audience,scopeTesting
mint dev/docs/api/authentication/on-behalf-of-token-exchange/get-tokenScreenshots
Preview available at http://localhost:3000/docs/api/authentication/on-behalf-of-token-exchange/get-token
Related Documentation
🤖 Generated with Claude Code