Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Swagger Authorization - Simple Guide

Step-by-Step Process & Entities

...

Entities Involved

1. Developer/Tester (Browser)

  • Person accessing Swagger UI for API testing
  • Can be a developer, QA tester, or technical user
  • Uses their Microsoft credentials to authenticate with Swagger

2. Swagger UI (Interactive API Documentation)

  • Web-based API documentation and testing interface
  • Built into both ApiService and IntegrationServiceAPI
  • Location: /swagger endpoint (e.g., http://localhost:7532/swagger)
  • Allows developers to test API endpoints interactively
  • Uses Scalar UI for enhanced API documentation

3. Microsoft Entra ID (Azure AD Tenant)

  • Microsoft's cloud identity service
  • Stores developer credentials and profiles
  • Tenant ID: 6073ce8b-73f3-4df4-9b80-5e40cdc6965f
  • Issues JWT tokens after successful authentication
  • Hosted by Microsoft (external service)

4. Swagger Client Application

  • Azure AD app registration specifically for Swagger UI
  • Client ID: 84c38b43-12e4-4c26-8292-8910d79aa532
  • Type: Single Page Application (SPA) with PKCE enabled
  • Registered in the same Azure AD tenant

5. ApiService (Backend REST API)

6. IntegrationServiceAPI (Integration REST API)