How umbraco/umbraco.authorizedservices works
Key Components to Include:
Core System Components
• Backoffice UI Layer (Settings Section Tree)
• Authorization Service Layer
• Storage Layer
• API Integration Layer
• Configuration Management
External Integration Points
• Third-party OAuth Services
• API Key Services
• Umbraco CMS Core
Top Level (User Interface)
• [Umbraco Backoffice UI]
• Settings Section
• Authorized Services Tree
Middle Layer (Service Management)
• [Authorization Services]
• AuthorizedServiceAuthorizer
• AuthorizationUrlBuilder
• TokenFactory
• ServiceResponseMetadataParser
Storage Layer
• [Storage Services]
• DatabaseKeyStorage
• DatabaseOAuth1TokenStorage
• DatabaseOAuth2TokenStorage
• SecretEncryptor
Integration Layer
• [External Service Integration]
• AuthorizedServiceCaller
• AuthorizationRequestSender
• AuthorizedRequestBuilder
• API endpoints and connections
Configuration Layer
• [Configuration Management]
• Service Settings
• Authentication Methods
• API Configurations
• Configuration flow
Important Flows to Highlight:
OAuth2 Authorization Flow
• Intermediate steps (authorization, token exchange, storage)
• Use different line styles for different types of requests
OAuth1 Authorization Flow
• Similar to OAuth2 but with OAuth1-specific components
• Request token and access token exchange process
API Key Flow
• Simpler direct flow for API key authentication
• Encryption and storage steps
Design Guidelines:
Component Relationships
• Clear dependencies between components
• Interface implementations
Labels and Documentation
• Clear labels for all components
• Brief descriptions for key processes
• Interface names where relevant
Security Flow
• Encryption points
• Token storage security
• Secure communication channels
Error Handling
• Error flow paths
• Retry mechanisms
• Fallback processes
• Clear component representation
• Export to common formats
• Easy updates and modifications