GitHub Mirrored Access Controls

[maxmurphySF]

What

Implement a system in Backstage that mirrors access controls and permissions from GitHub, creating a personalized experience where users only see repositories they have access to in GitHub. This feature will integrate with GitHub's API to fetch and sync user permissions, then apply these permissions to Backstage's interface.

Key implementation tasks:

1. Develop an integration with GitHub's API to fetch user permissions

• Implement OAuth flow for user authentication
• Retrieve user's repository access information

2. Create a storage system in Backstage for GitHub permissions

• Design and implement a database schema for storing user permissions
• Implement a caching mechanism for efficient permission checks

3. Develop a synchronization mechanism to keep Backstage permissions up-to-date with GitHub

• Implement periodic syncing of permissions
• Create a mechanism for immediate updates on user action (e.g., login)

4. Modify Backstage's frontend to filter content based on user permissions

• Implement permission checks in repository listing components
• Update search functionality to respect user permissions

5. Implement error handling and edge cases

• Handle scenarios where GitHub API is unavailable
• Manage conflicts between Backstage and GitHub permissions

6. Create admin interface for managing permission syncing

• Develop tools for manual permission refresh
• Implement logging for sync activities and errors

Done When

• GitHub API integration is complete and successfully fetches user permissions
• Backstage correctly stores and caches GitHub permissions
• Synchronization mechanism is implemented and keeps permissions up-to-date
• Backstage frontend successfully filters content based on user's GitHub permissions
• Error handling mechanisms are in place and tested
• Admin interface for permission management is functional
• Performance tests show the system can handle the expected user load
• Security audit of the permission system is completed
• User acceptance testing confirms the correct display of repositories based on GitHub permissions
• Documentation for the new feature is created, including user guide and admin instructions